StringArray Node.js Reference Documentation
StringArray
Current Version: 10.1.2
Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.
Object Creation
var obj = new chilkat.StringArray();
Properties
Count
· integer, read-only
The number of strings contained within the object's internal array (i.e. ordered collection).
Important: This is an object that contains a collection of strings. Although the class/object name includes the word "Array", it should not be confused with an array in the sense of the primitive array type used in a given programming language.
topCrlf
· boolean
If true, strings are always automatically converted to use CRLF line endings. If false, strings are automatically converted to use bare LF line endings.
topDebugLogFilePath
· string
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
· string, read-only
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
· string, read-only
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
· string, read-only
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
· boolean
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topLength
· integer, read-only
The number of strings contained within the internal collection. (Identical to the Count property.)
topTrim
· boolean
If true, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.
topUnique
· boolean
If true, then duplicates are not allowed. When an attempt is made to insert a string that already exists, the duplicate insertion is silently suppressed and no error is returned. The default value is false.
topVerboseLogging
· boolean
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
· string, read-only
Methods
Append
· Returns Boolean (true for success, false for failure).
· str String
Appends a string to the end of the internal ordered collection.
Returns true for success, false for failure.
topAppendSerialized
· Returns Boolean (true for success, false for failure).
· encodedStr String
Appends multiple strings to the end of the internal ordered collection. The encodedStr is what is returned from the Serialize method (see below).
Returns true for success, false for failure.
topClear
· Does not return anything (returns Undefined).
Remove all strings from the internal collection.
topContains
· Returns a Boolean.
· str String
Returns true if the string is present in the internal collection. The string comparisons are case sensitive.
topFind
· Returns a Number.
· findStr String
· startIndex Number
Finds the index of the first string equal to findStr. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.
topFindFirstMatch
· Returns a Number.
· matchPattern String
· startIndex Number
Finds the first string that matches the matchPattern. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.
The matchPattern may contain zero or more asterisk chars, each of which matches 0 or more of any character.
topGetString
· Returns a String.
· index Number
Returns the string at an indexed location within the internal collection. The first string is located at index 0.
Returns null on failure
topGetStringLen
· Returns a Number.
· index Number
Returns Nth string's length, in characters. The first string is located at index 0.
topInsertAt
· Does not return anything (returns Undefined).
· index Number
· str String
Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.
topLastString
· Returns a String.
LoadFromFile
· Returns Boolean (true for success, false for failure).
· path String
Loads strings from a file (one per line) into the internal collection. It is assumed the file contains ANSI strings. To load from a file containing non-ANSI strings (such as utf-8), call LoadFromFile2 instead.
Note: This method appends the strings in path to the existing collection of strings contained in this object.
Returns true for success, false for failure.
topLoadFromFile2
· Returns Boolean (true for success, false for failure).
· path String
· charset String
Loads strings from a file (one per line) into the internal collection. The charset specifies the character encoding (such as utf-8) of the strings contained in the file.
Note: This method appends the strings in path to the existing collection of strings contained in this object.
Returns true for success, false for failure.
topLoadFromText
· Does not return anything (returns Undefined).
· str String
Loads strings from an in-memory string (one per line) into the internal collection.
Note: This method appends the strings in str to the existing collection of strings contained in this object.
topLoadTaskResult
· Returns Boolean (true for success, false for failure).
· task Task
Loads the string collection from a completed asynchronous task.
Returns true for success, false for failure.
topPop
· Returns a String.
Prepend
· Does not return anything (returns Undefined).
· str String
Adds a string to the beginning of the internal collection.
topRemove
· Does not return anything (returns Undefined).
· str String
Removes all strings equal to the string argument from the internal collection.
topRemoveAt
· Returns a Boolean.
· index Number
Removes the string at a particular index.
topReplaceAt
· Does not return anything (returns Undefined).
· index Number
· str String
Replaces the string at a specified index.
topSaveNthToFile
· Returns Boolean (true for success, false for failure).
· index Number
· saveToPath String
SaveToFile
· Returns Boolean (true for success, false for failure).
· path String
Saves the collection of strings to a file, one string per line. Strings are saved using the ANSI charset. (Call SaveToFile2 to specify a charset, such as "utf-8")
Returns true for success, false for failure.
topSaveToFile2
· Returns Boolean (true for success, false for failure).
· saveToPath String
· charset String
Saves the collection of strings to a file, one string per line. Strings are saved using the specified charset.
Returns true for success, false for failure.
topSaveToText
· Returns a String.
Writes the collection of strings to a single string, one per line (separated by CRLF line endings).
Returns null on failure
topSerialize
· Returns a String.
Returns an string which is an encoded representation of all the strings in the collection. The string collection can be re-created by calling the AppendSerialized method.
Returns null on failure
topSort
· Does not return anything (returns Undefined).
· ascending Boolean
Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to true, otherwise set ascending equal to false.
topSplitAndAppend
· Does not return anything (returns Undefined).
· str String
· boundary String
Splits a string at a character or substring boundary and adds each resulting string to the internal collection.
topSubtract
· Does not return anything (returns Undefined).
· stringArrayObj StringArray
Subtracts the strings contained within stringArrayObj from the caller's internal collection.
topUnion
· Does not return anything (returns Undefined).
· stringArrayObj StringArray
Performs the union set-operator. The result is that the caller will have a string collection that is the union of itself and stringArrayObj.
top