@chilkat/react-native 11.6.1

package/src/specs/Hashtable.nitro.ts

@@ -0,0 +1,356 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringBuilder } from './StringBuilder.nitro'
+import type { StringTable } from './StringTable.nitro'
+
+/**
+ * Store, look up, remove, enumerate, import, and serialize key/value pairs.
+ *
+ * `Hashtable` provides a simple key/value collection for
+ * storing string and integer values by key. It can add or replace entries,
+ * look up values, test whether keys exist, remove entries, count items,
+ * enumerate keys, import URL query parameters, serialize values back to a
+ * query string, and save or load the table in XML format.
+ *
+ * **String and integer values**
+ *
+ * Store values as strings or integers using straightforward add, replace,
+ * and lookup methods.
+ *
+ * **Fast key lookup**
+ *
+ * Check whether a key exists and retrieve its value without manually
+ * scanning a list or parsing text.
+ *
+ * **Add, replace, and remove**
+ *
+ * Maintain a mutable collection by adding new entries, replacing existing
+ * values, removing individual keys, or clearing the table.
+ *
+ * **Enumerate keys**
+ *
+ * Retrieve the set of keys when application logic needs to loop through
+ * the stored entries.
+ *
+ * **Query string helpers**
+ *
+ * Import URL query parameters into the table and serialize the table back
+ * to a query-string representation.
+ *
+ * **XML persistence**
+ *
+ * Save the hashtable to XML or reload it from XML when values need to be
+ * persisted or transferred in a simple structured format.
+ *
+ * **Common pattern:**
+ * Use `Hashtable` when application code needs a small mutable
+ * key/value table, especially for lookup tables, parsed query parameters, or
+ * simple string/integer settings. Add values with `AddStr` or
+ * `AddInt`, retrieve them with `LookupStr` or
+ * `LookupInt`, and use XML or query-string methods when the table
+ * needs to be saved, loaded, or converted.
+ *
+ * For an extended overview, see
+ * [Hashtable Class Overview](https://www.chilkatsoft.com/hashtable_class_overview.asp).
+ *
+ * Each `Hashtable` 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 Hashtable()`.
+ */
+export interface Hashtable 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 entries currently stored in the hashtable.
+   *
+   * Each key contributes one entry regardless of whether its value is a string or an integer.
+   * Adding a new key increases `Count`; replacing the value of an existing key does not. Removing
+   * an entry decreases it, and `Clear` resets it to `0`.
+   *
+   * This property is read-only.
+   */
+  readonly count: number
+
+  // ---- Methods ----
+
+  /**
+   * Adds an entry whose string key is `ARG1` and whose value is the integer `ARG2`. If the key
+   * already exists, its previous value is replaced.
+   *
+   * Returns `true` when the entry is added or replaced. Returns `false` if the operation cannot be
+   * completed, such as because memory could not be allocated.
+   *
+   * **One entry per key:** Adding the same key again replaces the existing value; it does not
+   * create a second entry. Replacing a value does not increase `Count`. Use `LookupInt` to retrieve
+   * an integer value.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  addInt(key: string, value: number): void
+
+  /**
+   * Adds an entry whose string key is `ARG1` and whose value is the string `ARG2`. If the key
+   * already exists, its previous value is replaced.
+   *
+   * Returns `true` when the entry is added or replaced. Returns `false` if the operation cannot be
+   * completed, such as because memory could not be allocated.
+   *
+   * **One entry per key:** Adding the same key again replaces the existing value; it does not
+   * create a second entry. Replacing a value does not increase `Count`. Use `LookupStr` to retrieve
+   * a string value.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  addStr(key: string, value: string): void
+
+  /**
+   * Removes every entry from the hashtable. After this call, `Count` is `0`.
+   *
+   * The current hash-table capacity is retained. To clear the entries and also select a different
+   * bucket capacity, call `ClearWithNewCapacity`.
+   */
+  clear(): void
+
+  /**
+   * Removes every entry and reinitializes the hashtable with `ARG1` buckets. The initial default
+   * capacity of a new `Hashtable` object is `521`.
+   *
+   * Returns `true` on success and `false` if the table cannot be reinitialized.
+   *
+   * TermMeaning
+   *
+   * | `Count` |  | The number of stored entries. |
+   *
+   * | Capacity |  | The number of hash buckets, not a maximum entry count. |
+   *
+   * **Performance note:** More buckets can reduce collisions for a large table, but use more
+   * memory. Choosing roughly twice the expected number of entries and using a prime number are
+   * tuning guidelines, not correctness requirements.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  clearWithNewCapacity(capacity: number): void
+
+  /**
+   * Returns `true` if the hashtable contains the string key `ARG1`; otherwise returns `false`. The
+   * result tests key existence regardless of the value stored for that key.
+   *
+   * **Useful before lookup:** Call `Contains` when a lookup result could be ambiguous. For example,
+   * `LookupInt` returns `0` both for a missing key and for an entry whose value is actually zero.
+   */
+  contains(key: string): boolean
+
+  /**
+   * Returns the integer value associated with the string key `ARG1`. This method is intended for
+   * entries stored with `AddInt`.
+   *
+   * If the key does not exist, the return value is `0`.
+   *
+   * **Missing key versus zero:** Because `0` is also a valid stored value, call `Contains` first
+   * when the application must distinguish a missing key from an entry containing zero.
+   */
+  lookupInt(key: string): number
+
+  /**
+   * Returns the string value associated with the string key `ARG1`. This method is intended for
+   * entries stored as strings, including entries added by `AddStr` or `AddQueryParams`.
+   *
+   * **Check lookup success:** The representation of a failed string-returning call varies by
+   * programming language and may be `null`, `Nothing`, or an empty string. An empty string may also
+   * be a legitimate value. Use `Contains` or `LastMethodSuccess` when the distinction matters.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  lookupStr(key: string): string
+
+  /**
+   * Removes the entry whose string key is `ARG1`.
+   *
+   * - Returns `true` if the key existed and the entry was removed.
+   *
+   * - Returns `false` if the key was not present.
+   *
+   * A `false` result caused by an absent key is a normal lookup outcome, not an indication that the
+   * hashtable was damaged. Removing an existing entry decreases `Count` by one.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  remove(key: string): void
+
+  /**
+   * Appends all hashtable key strings to the `StringTable` passed in `ARG1`. Existing strings
+   * already contained in `ARG1` are not cleared.
+   *
+   * Returns `true` on success and `false` on failure.
+   *
+   * **Enumeration order:** Hashtable keys may be returned in any order. Do not depend on insertion
+   * order or sorted order. Clear the destination `StringTable` first when it should contain only
+   * the current hashtable keys.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  getKeys(strTable: StringTable): void
+
+  /**
+   * Parses URL query parameters from `ARG1` and adds them to the hashtable as string entries. Pass
+   * the query component in the following form:
+   *
+   * ```
+   * field1=value1&field2=value2&field3=value3
+   * ```
+   *
+   * Each value is expected to be URL encoded and is URL decoded before being stored. If an imported
+   * key already exists, its previous value is replaced. Returns `true` on success and `false` if
+   * the query parameters cannot be imported.
+   *
+   * **Repeated parameter names:** A hashtable stores one value per key. It cannot preserve a query
+   * string containing several independent values with the same field name. Use a list-oriented
+   * parser when repeated names must remain distinct.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  addQueryParams(queryParams: string): void
+
+  /**
+   * Serializes the current hashtable to Chilkat's hashtable XML format and appends the XML to the
+   * `StringBuilder` passed in `ARG1`. Existing content in the `StringBuilder` is preserved.
+   *
+   * Returns `true` on success and `false` on failure. The generated XML can be loaded by
+   * `AddFromXmlSb`.
+   *
+   * ```
+   * &lt;hashtable&gt;
+   *   &lt;e&gt;&lt;k&gt;key&lt;/k&gt;&lt;v&gt;value&lt;/v&gt;&lt;/e&gt;
+   * &lt;/hashtable&gt;
+   * ```
+   *
+   * **Ordering:** Because hashtable enumeration order is not defined, do not rely on entries
+   * appearing in insertion order or use the serialized text as a canonical, byte-for-byte
+   * representation.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  toXmlSb(sbXml: StringBuilder): void
+
+  /**
+   * Reads hashtable XML previously produced by `ToXmlSb` from the `StringBuilder` passed in `ARG1`
+   * and adds the entries to this table.
+   *
+   * The operation merges with the existing table: keys not present in the XML remain, and an
+   * imported entry replaces the current value for the same key. Call `Clear` first when the XML
+   * should completely replace the current contents.
+   *
+   * Returns `true` when the XML is parsed and imported successfully; otherwise returns `false`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  addFromXmlSb(sbXml: StringBuilder): void
+
+  /**
+   * Returns `true` if the hashtable contains the integer key `ARG1`; otherwise returns `false`.
+   *
+   * **Key type:** This method accepts an integer key. It is distinct from `Contains`, which tests
+   * for a string key, and from `AddInt`, whose key is a string and whose value is an integer.
+   */
+  containsIntKey(key: number): boolean
+
+  /**
+   * Serializes the hashtable as a URL query string in the following form:
+   *
+   * ```
+   * key1=value1&key2=value2&key3=value3
+   * ```
+   *
+   * Each value is URL encoded. The returned string does not include a leading `?`.
+   *
+   * **Important limitations:** Key order is not defined, and a hashtable contains only one value
+   * per key. Therefore the output is not suitable when parameter order is significant or repeated
+   * field names must be preserved. In language bindings where string-return failure is ambiguous,
+   * check `LastMethodSuccess`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Hashtable.lastErrorText}.
+   */
+  toQueryString(): string
+}

package/src/specs/HtmlToText.nitro.ts

@@ -0,0 +1,238 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Convert HTML into readable plain text with control over links, wrapping, and encoding.
+ *
+ * `HtmlToText` converts HTML content into readable plain
+ * text. It can decode HTML entities, wrap output at a configurable right
+ * margin, optionally include or suppress hyperlink URLs, convert HTML supplied
+ * as a string or `StringBuilder`, and read or write files using an
+ * explicit character encoding.
+ *
+ * **HTML to plain text**
+ *
+ * Convert HTML markup into readable text suitable for display, logging,
+ * indexing, email alternatives, or text-only output.
+ *
+ * **Entity decoding**
+ *
+ * Decode HTML entities so text such as named entities and numeric
+ * character references becomes normal readable output.
+ *
+ * **Line wrapping**
+ *
+ * Use `RightMargin` to wrap text at a chosen width, or set it to
+ * `0` when no right-margin wrapping is wanted.
+ *
+ * **Link handling**
+ *
+ * Suppress hyperlink URLs for cleaner text, or emit URLs when the output
+ * needs to preserve the destination of HTML links.
+ *
+ * **StringBuilder support**
+ *
+ * Convert HTML directly from a `StringBuilder` when working with
+ * larger or incrementally built HTML content.
+ *
+ * **File and charset helpers**
+ *
+ * Read HTML from files and write text output using a specified character
+ * encoding.
+ *
+ * **Common pattern:**
+ * Provide the HTML as a string, file, or `StringBuilder`, choose
+ * whether to decode entities and include link URLs, set the desired right
+ * margin, then convert the result to plain text. Use
+ * `HtmlToText` when the goal is readable text, not structured XML
+ * or DOM-style parsing.
+ *
+ * For an extended overview, see
+ * [HtmlToText Class Overview](https://www.chilkatsoft.com/htmltotext_class_overview.asp).
+ *
+ * Each `HtmlToText` 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 HtmlToText()`.
+ */
+export interface HtmlToText 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
+
+  /**
+   * Controls whether HTML character references are decoded when converting HTML to plain text. The
+   * default value is `true`.
+   *
+   * Value
+   * Behavior
+   *
+   * | `true` |
+   * | HTML entities and numeric character references are decoded to their corresponding characters.
+   * For example, `_AMP_amp;` becomes `_AMP_`. |
+   *
+   * | `false` |
+   * | Character references are left encoded in the plain-text output. |
+   *
+   * **Typical use:** Leave this property set to `true` when the goal is human-readable text. Set it
+   * to `false` when the original entity notation itself must be preserved.
+   */
+  decodeHtmlEntities: boolean
+
+  /**
+   * Controls line wrapping in the generated plain text. The default value is `80`. As a line
+   * approaches the configured margin, Chilkat attempts to wrap at a SPACE character. Set this
+   * property to `0` to disable right-margin wrapping.
+   *
+   * **Soft margin:** The right margin is a preferred wrapping point, not a guaranteed maximum line
+   * length. A long sequence with no suitable SPACE character may extend beyond the configured
+   * margin.
+   */
+  rightMargin: number
+
+  /**
+   * Controls whether hyperlink destination URLs are included in the generated plain text. The
+   * default value is `true`.
+   *
+   * Value
+   * Behavior
+   *
+   * | `true` |
+   * | The visible anchor text is retained, but hyperlink destination URLs are omitted. |
+   *
+   * | `false` |
+   * | Hyperlink URLs are included. By default, they are collected in a `References:` section at the
+   * end of the plain text. |
+   *
+   * For example, with `SuppressLinks` set to `false`, an HTML link whose visible text is `chilkat`
+   * and whose URL is `https://www.chilkatsoft.com/` produces the visible text and a numbered
+   * reference at the end of the output.
+   *
+   * **Related options:** When link URLs are enabled, `UncommonOptions` can be used to suppress the
+   * trailing references list with `NoReferencesList` or emit URLs inline with `EmitUrls`.
+   */
+  suppressLinks: boolean
+
+  /**
+   * Specifies uncommon HTML-to-text conversion options as a comma-separated list of keywords. The
+   * default is the empty string, which is appropriate for normal use.
+   *
+   * Keyword
+   * Effect
+   *
+   * | `NoReferencesList` |
+   * | Does not generate the hyperlink-reference list at the end of the plain-text output. |
+   *
+   * | `EmitUrls` |
+   * | Emits hyperlink URLs inline in the plain-text output instead of relying on the default
+   * trailing reference list. |
+   *
+   * **Interaction with SuppressLinks:** These options control the presentation of hyperlink URLs
+   * when URL output is enabled. If `SuppressLinks` is `true`, hyperlink URLs are suppressed.
+   */
+  uncommonOptions: string
+
+  // ---- Methods ----
+
+  /**
+   * Converts the HTML in `html` to readable plain text and returns the result.
+   *
+   * The conversion honors `DecodeHtmlEntities`, `RightMargin`, `SuppressLinks`, and
+   * `UncommonOptions`. HTML markup is interpreted to produce readable text rather than simply being
+   * removed with a tag-stripping operation.
+   *
+   * **Plain-text conversion:** The output is intended for reading, indexing, logging, email text
+   * alternatives, and similar text-oriented uses. It is not intended to preserve the original HTML
+   * markup or visual layout exactly.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToText.lastErrorText}.
+   */
+  toText(html: string): string
+
+  /**
+   * Converts the HTML currently contained in `sb` to plain text in place. On success, the same
+   * `StringBuilder` contains the converted plain-text result.
+   *
+   * The conversion honors `DecodeHtmlEntities`, `RightMargin`, `SuppressLinks`, and
+   * `UncommonOptions`.
+   *
+   * **StringBuilder workflow:** Use this method when the HTML is already held in a `StringBuilder`
+   * and you want the conversion result returned through that same object rather than as a separate
+   * string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HtmlToText.lastErrorText}.
+   */
+  toTextSb(sb: StringBuilder): void
+}