@chilkat/react-native 11.6.1

package/src/specs/StringTable.nitro.ts

@@ -0,0 +1,271 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Store, load, search, sort, split, retrieve, and save ordered lists of strings.
+ *
+ * `StringTable` is a simple ordered collection of strings.
+ * It can append strings directly, load one string per line from files or
+ * `StringBuilder`, search for substrings or wildcard matches, sort
+ * the collection, split strings into entries, retrieve strings by index, export
+ * the table as line-delimited text, and save the result to a file.
+ *
+ * **Ordered string collection**
+ *
+ * Store a list of strings in insertion order and retrieve individual
+ * entries by zero-based index.
+ *
+ * **Append and import**
+ *
+ * Add strings directly, append strings from a file, or load line-delimited
+ * text from a `StringBuilder`.
+ *
+ * **Search strings**
+ *
+ * Find entries containing a substring or matching a wildcard pattern when
+ * filtering or locating text values.
+ *
+ * **Sort entries**
+ *
+ * Sort the string collection when deterministic ordering or user-facing
+ * display order is needed.
+ *
+ * **Split into entries**
+ *
+ * Split delimited text into separate string-table entries for easier
+ * indexing, searching, sorting, or saving.
+ *
+ * **Export and save**
+ *
+ * Convert the table back to line-delimited text, copy it to a
+ * `StringBuilder`, or save the collection to a file.
+ *
+ * **Common pattern:**
+ * Use `StringTable` when application code needs a lightweight
+ * ordered list of text values. Append or load the strings, search or sort as
+ * needed, retrieve entries by index with `StringAt` or
+ * `StringAtSb`, then export the final list as line-delimited text or
+ * save it to a file.
+ *
+ * For an extended overview, see
+ * [StringTable Class Overview](https://www.chilkatsoft.com/stringtable_class_overview.asp).
+ *
+ * Each `StringTable` instance owns a native Chilkat object. It is released when the JavaScript
+ * object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new StringTable()`.
+ */
+export interface StringTable extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * 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.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: 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.
+   */
+  debugLogFilePath: string
+
+  /**
+   * 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.
+   */
+  verboseLogging: 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. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The number of strings in the table.
+   *
+   * This property is read-only.
+   */
+  readonly count: number
+
+  // ---- Methods ----
+
+  /**
+   * Appends strings, one per line, from a file. Each line in the `path` should be no longer than
+   * the length specified in `maxLineLen`. The `charset` indicates the character encoding of the
+   * contents of the file, such as `utf-8`, `iso-8859-1`, `Shift_JIS`, etc.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  appendFromFile(maxLineLen: number, charset: string, path: string): void
+
+  /**
+   * Appends a string to the table.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  append(value: string): void
+
+  /**
+   * Returns the Nth string in the table. The `index` is 0-based. (The first string is at index 0.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  stringAt(index: number): string
+
+  /**
+   * Saves the string table to a file. The `charset` is the character encoding to use, such as
+   * `utf-8`, `iso-8859-1`, `windows-1252`, `Shift_JIS`, `gb2312`, etc. If `bCrlf` is `true`, then
+   * CRLF line endings are used, otherwise LF-only line endings are used.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  saveToFile(charset: string, bCrlf: boolean, path: string): void
+
+  /**
+   * Splits a string into parts based on a single character `delimiterChar`. If `exceptDoubleQuoted`
+   * is `true`, then the delimiter char found between double quotes is not treated as a delimiter.
+   * If `exceptEscaped` is `true`, then an escaped (with a backslash) delimiter char is not treated
+   * as a delimiter.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  splitAndAppend(inStr: string, delimiterChar: string, exceptDoubleQuoted: boolean, exceptEscaped: boolean): void
+
+  /**
+   * Appends strings, one per line, from the contents of a StringBuilder object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  appendFromSb(sb: StringBuilder): void
+
+  /**
+   * Removes all the strings from the table.
+   */
+  clear(): void
+
+  /**
+   * Returns the Nth string in the table, converted to an integer value. The `index` is 0-based.
+   * (The first string is at index 0.) Returns -1 if no string is found at the specified index.
+   * Returns 0 if the string at the specified index exist, but is not an integer.
+   */
+  intAt(index: number): number
+
+  /**
+   * Return the index of the first string in the table containing `substr`. Begins searching strings
+   * starting at `startIndex`. If `caseSensitive` is `true`, then the search is case sensitive. If
+   * `caseSensitive` is `false` then the search is case insensitive. Returns -1 if the `substr` is
+   * not found.
+   */
+  findSubstring(startIndex: number, substr: string, caseSensitive: boolean): number
+
+  /**
+   * 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`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  sort(ascending: boolean, caseSensitive: boolean): void
+
+  /**
+   * Return the number of strings specified by `count`, one per line, starting at `startIdx`. To
+   * return the entire table, pass 0 values for both `startIdx` and `count`. Set `crlf` equal to
+   * `true` to emit with CRLF line endings, or `false` to emit LF-only line endings. The last string
+   * is emitted includes the line ending.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  getStrings(startIdx: number, count: number, crlf: boolean): string
+
+  /**
+   * This string table object holds strings with wildcards. The method returns the index of the
+   * wildcarded string that matches the text in `sb`, or -1 if no match is found. `caseSensitive`
+   * specifies whether the matching should be case-sensitive.
+   */
+  findMatch(sb: StringBuilder, caseSensitive: boolean): number
+
+  /**
+   * The method performs a case-insensitive search to return the index of a table entry matching
+   * `sb`, or -1 if there is no match. Set `captureEmailAddr` to `true` if the target word is
+   * expected to be an email address, otherwise set `captureEmailAddr` to `false`. `sbWord` will
+   * receive the word (email address) following the matched text.
+   *
+   * This method helps replace the outdated Chilkat Bounce class, which was used for identifying and
+   * categorizing bounced email types.
+   */
+  wordFollowing(sb: StringBuilder, captureEmailAddr: boolean, sbWord: StringBuilder): number
+
+  /**
+   * Appends the Nth string in the table to `sb`. The `index` is 0-based. (The first string is at
+   * index 0.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  stringAtSb(index: number, sb: StringBuilder): void
+
+  /**
+   * Appends the entire string table to `sb` using CRLF line endings.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringTable.lastErrorText}.
+   */
+  toSb(sb: StringBuilder): void
+}