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.

Important: The Chilkat StringTable class is a better choice for a large number of strings.

Object Creation

var obj = new chilkat.StringArray();

Properties

Count
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.

top
Crlf
Crlf
· 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.

top
DebugLogFilePath
DebugLogFilePath
· 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.

More Information and Examples
top
LastErrorHtml
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.

top
LastErrorText
LastErrorText
· 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.

top
LastErrorXml
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.

top
LastMethodSuccess
LastMethodSuccess
· 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.

top
Length
Length
· integer, read-only

The number of strings contained within the internal collection. (Identical to the Count property.)

top
Trim
Trim
· 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.

top
Unique
Unique
· 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.

top
VerboseLogging
VerboseLogging
· 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.

top
Version
Version
· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

Append
var status = Append(str);
· 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.

top
AppendSerialized
var status = AppendSerialized(encodedStr);
· 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.

top
Clear
Clear();
· Does not return anything (returns Undefined).

Remove all strings from the internal collection.

top
Contains
var retBool = Contains(str);
· Returns a Boolean.
· str String

Returns true if the string is present in the internal collection. The string comparisons are case sensitive.

top
Find
var retInt = Find(findStr, startIndex);
· 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.

top
FindFirstMatch
var retInt = FindFirstMatch(matchPattern, startIndex);
· 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.

top
GetString
var retStr = GetString(index);
· 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

top
GetStringLen
var retInt = GetStringLen(index);
· Returns a Number.
· index Number

Returns Nth string's length, in characters. The first string is located at index 0.

top
InsertAt
InsertAt(index, str);
· 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.

top
LastString
var retStr = LastString();
· Returns a String.

Returns the last string in the internal collection.

Returns null on failure

top
LoadFromFile
var status = LoadFromFile(path);
· 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.

top
LoadFromFile2
var status = LoadFromFile2(path, charset);
· 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.

top
LoadFromText
LoadFromText(str);
· 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.

top
LoadTaskResult
var status = LoadTaskResult(task);
· Returns Boolean (true for success, false for failure).
· task Task
Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns true for success, false for failure.

top
Pop
var retStr = Pop();
· Returns a String.

Returns the last string and removes it from the internal collection.

Returns null on failure

top
Prepend
Prepend(str);
· Does not return anything (returns Undefined).
· str String

Adds a string to the beginning of the internal collection.

top
Remove
Remove(str);
· Does not return anything (returns Undefined).
· str String

Removes all strings equal to the string argument from the internal collection.

top
RemoveAt
var retBool = RemoveAt(index);
· Returns a Boolean.
· index Number

Removes the string at a particular index.

top
ReplaceAt
ReplaceAt(index, str);
· Does not return anything (returns Undefined).
· index Number
· str String
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveNthToFile
var status = SaveNthToFile(index, saveToPath);
· Returns Boolean (true for success, false for failure).
· index Number
· saveToPath String

Saves the Nth string in the collection to a file.

Returns true for success, false for failure.

top
SaveToFile
var status = SaveToFile(path);
· 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.

top
SaveToFile2
var status = SaveToFile2(saveToPath, charset);
· 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.

top
SaveToText
var retStr = SaveToText();
· Returns a String.

Writes the collection of strings to a single string, one per line (separated by CRLF line endings).

Returns null on failure

top
Serialize
var retStr = Serialize();
· 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

top
Sort
Sort(ascending);
· 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.

top
SplitAndAppend
SplitAndAppend(str, boundary);
· 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.

top
Subtract
Subtract(stringArrayObj);
· Does not return anything (returns Undefined).
· stringArrayObj StringArray

Subtracts the strings contained within stringArrayObj from the caller's internal collection.

top
Union
Union(stringArrayObj);
· 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