StringArray React Native Reference Documentation

StringArray

Current Version: 11.6.1

Chilkat.StringArray

Manage an ordered collection of strings, with StringTable recommended for new code.

Chilkat.StringArray is an ordered string-collection class that can append, prepend, insert, replace, remove, pop, and retrieve strings by index. It can load one string per line from files or in-memory text, save the collection back to text or files, enforce uniqueness, trim incoming values, normalize line endings, search by exact value or wildcard pattern, sort entries, split text into entries, serialize and restore the collection, and perform set-style operations such as union and subtraction.

Recommendation: For new development, prefer Chilkat.StringTable instead of Chilkat.StringArray. StringTable provides a simpler, faster, and more memory-efficient way to manage ordered lists of strings. Use StringArray primarily when maintaining existing code or when a specific API or older example already uses it.

Ordered string collection

Store strings in an internal ordered collection and retrieve them by zero-based index using GetString, StrAt, or LastString.

Add and modify entries

Append, prepend, insert, replace, remove, clear, or pop strings as the collection changes.

Load and save text

Load one string per line from files or text, and save the collection back to files or a single line-delimited string.

Charset-aware file I/O

Use charset-specific load and save methods when working with UTF-8, UTF-16, or other non-ANSI text encodings.

Search, match, and sort

Check for exact strings, find values from a starting index, match wildcard patterns, and sort ascending or descending.

Serialize and combine

Serialize the collection for later restoration, split text into entries, and combine or subtract collections with set-style operations.

Common pattern: Create a StringArray, optionally set Trim, Crlf, or Unique, then append strings directly or load them from a file or text block. Search, sort, split, remove, union, or subtract entries as needed, then save the result with SaveToText, SaveToFile, or SaveToFile2. For new code that only needs an ordered list of strings, use Chilkat.StringTable instead.

Naming note: Although the class name contains Array, Chilkat.StringArray is a Chilkat object that manages an ordered string collection. It should not be confused with a native array type in a programming language.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, StringArray } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const stringArray = new StringArray()
// ... the native object is released when `stringArray` is garbage collected, or now with stringArray.dispose()

new StringArray()

Creates the underlying native Chilkat object. StringArray is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  stringArray.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // StringArray.someMethod(...): <reason>
  console.log(stringArray.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await stringArray.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // StringArray.someMethodAsync: <reason>
}

Properties

Count

// read-only
readonly count: number

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.

StringArray React Native Reference Documentation

StringArray

Current Version: 11.6.1

Manage an ordered collection of strings, with StringTable recommended for new code.

Ordered string collection

Add and modify entries

Load and save text

Charset-aware file I/O

Search, match, and sort

Serialize and combine

Object Creation

Errors

Properties

Count

Crlf

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Length

Trim

Unique

VerboseLogging

Version

Methods

Append

AppendSerialized

Clear

Contains

Find

FindFirstMatch

GetString

GetStringLen

InsertAt

LastString

LoadFromFile

LoadFromFile2

LoadFromText

Pop

Prepend

Remove

RemoveAt

ReplaceAt

SaveNthToFile

SaveToFile

SaveToFile2

SaveToText

Serialize

Sort

SplitAndAppend

StrAt

Subtract

Union