@chilkat/react-native 11.6.1

package/src/specs/StringBuilder.nitro.ts

@@ -0,0 +1,920 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { JsonObject } from './JsonObject.nitro'
+import type { StringTable } from './StringTable.nitro'
+
+/**
+ * Build, transform, search, encode, decode, hash, and save mutable text.
+ *
+ * `StringBuilder` is a flexible mutable text container for
+ * constructing and transforming strings. It supports appending text, integers,
+ * random values, UUIDs, encoded bytes, and `BinData`; searching,
+ * comparing, extracting, replacing, masking, regex processing, line-ending
+ * normalization, encoding, decoding, hashing, Markdown conversion, file I/O,
+ * and secure clearing of sensitive text.
+ *
+ * **Build text incrementally**
+ *
+ * Append strings, characters, integers, random values, UUIDs, encoded data,
+ * and other Chilkat objects without repeatedly recreating strings.
+ *
+ * **Search and extract**
+ *
+ * Find substrings, compare content, extract ranges, split or inspect text,
+ * and work with selected portions of the buffer.
+ *
+ * **Replace and transform**
+ *
+ * Replace text, mask sensitive values, normalize line endings, trim or edit
+ * content, and apply regex-based processing when needed.
+ *
+ * **Encoding and decoding**
+ *
+ * Encode or decode text and binary data using formats such as Base64, hex,
+ * URL encoding, quoted-printable, and other supported encodings.
+ *
+ * **Hashing and conversion**
+ *
+ * Compute hashes of the current text, convert Markdown to HTML, and move
+ * content between `StringBuilder`, `BinData`, files,
+ * and plain strings.
+ *
+ * **File I/O and secure clearing**
+ *
+ * Load text from files, save text with explicit character encodings, and
+ * securely clear the buffer when it contains sensitive data.
+ *
+ * **Common pattern:**
+ * Use `StringBuilder` when text will be assembled or modified in
+ * multiple steps. Append or load the starting content, perform searches,
+ * replacements, encoding, decoding, hashing, or line-ending normalization, then
+ * retrieve the result as a string, save it to a file, or pass the object
+ * directly to another Chilkat method.
+ *
+ * For an extended overview, see
+ * [StringBuilder Class Overview](https://www.chilkatsoft.com/stringbuilder_class_overview.asp).
+ *
+ * Each `StringBuilder` 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 StringBuilder()`.
+ */
+export interface StringBuilder 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 characters of the string contained within this instance.
+   *
+   * This property is read-only.
+   */
+  readonly length: number
+
+  /**
+   * Returns the content of the string converted to an integer.
+   */
+  intValue: number
+
+  /**
+   * Returns `true` if the content contains only those characters allowed in the base64 encoding. A
+   * base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often
+   * padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is
+   * ignored.
+   *
+   * This property is read-only.
+   */
+  readonly isBase64: boolean
+
+  /**
+   * Returns `true` if the content contains one or more emoji characters.
+   *
+   * This property is read-only.
+   */
+  readonly hasEmojis: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Appends a copy of the specified string to this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  append(value: string): void
+
+  /**
+   * Appends the string representation of a specified 32-bit signed integer to this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendInt(value: number): void
+
+  /**
+   * Appends the string representation of a specified 64-bit signed integer to this instance.
+   *
+   * 64-bit integers are passed as JavaScript numbers (exact up to 2^53).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendInt64(value: number): void
+
+  /**
+   * Removes all characters from the current StringBuilder instance.
+   */
+  clear(): void
+
+  /**
+   * Replaces all occurrences of a specified string in this instance with another specified string.
+   * Returns the number of replacements.
+   */
+  replace(value: string, replacement: string): number
+
+  /**
+   * Returns the contents as a string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getAsString(): string
+
+  /**
+   * Returns `true` if the contents of this object equals the `str`. Returns `false` if unequal. For
+   * case insensitive equality, set `caseSensitive` equal to `false`.
+   */
+  contentsEqual(str: string, caseSensitive: boolean): boolean
+
+  /**
+   * Returns `true` if the `str` is contained within this object. For case sensitive matching, set
+   * `caseSensitive` equal to `true`. For case-insensitive, set `caseSensitive` equal to `false`.
+   */
+  contains(str: string, caseSensitive: boolean): boolean
+
+  /**
+   * Returns `true` if the contents of this object are well-formed JSON or XML. `format` selects
+   * which check to apply and must be `json` or `xml` (case insensitive). Returns `false` if the
+   * contents do not conform, or if `format` is anything else.
+   *
+   * Chilkat's JSON and XML parsers are deliberately tolerant. Given text that is not well-formed
+   * they can still report success, leaving an empty or partially populated document. This method
+   * answers the question those parsers do not, and it does so without loading the text into a
+   * `JsonObject` or `Xml` object first. The checks applied here are the same ones those classes
+   * apply when their `Strict` property is set.
+   *
+   * For `xml` this is a **well-formedness** check: element nesting and tag matching, attribute
+   * syntax and duplicate attributes, entity and character references, comments, processing
+   * instructions, CDATA sections, the XML declaration, the DOCTYPE declaration, and that the bytes
+   * are valid UTF-8 containing only characters XML permits. It is not a validating parse: no DTD or
+   * schema is read.
+   *
+   * For `json` the full RFC 8259 grammar is checked.
+   *
+   * Empty contents are not well-formed in either format, so `false` is returned.
+   *
+   * **Note:** The contents of this object are never modified by this method.
+   */
+  isWellFormed(format: string): boolean
+
+  /**
+   * Prepends a copy of the specified string to this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  prepend(value: string): void
+
+  /**
+   * Sets this instance to a copy of the specified string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  setString(value: string): void
+
+  /**
+   * Encodes to base64, hex, quoted-printable, URL encoding, etc. The `encoding` can be set to any
+   * of the following strings: `base64`, `hex`, `quoted-printable` (or `qp`), `url`, `base32`, `Q`,
+   * `B`, `url_rc1738`, `url_rfc2396`, `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for
+   * HTML entity encoding). The full up-to-date list of supported binary encodings is available at
+   * the link entitled `Supported Binary Encodings` below.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  encode(encoding: string, charset: string): void
+
+  /**
+   * Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or
+   * URL-encoding. The `encoding` can be set to any of the following strings: `base64`, `hex`,
+   * `quoted-printable` (or `qp`), `url`, `base32`, `Q`, `B`, `url_rc1738`, `url_rfc2396`,
+   * `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for HTML entity encoding). The full
+   * up-to-date list of supported binary encodings is available at the link entitled `Supported
+   * Binary Encodings` below.
+   *
+   * Note: The Encode method modifies the content of this object. The GetEncoded method leaves this
+   * object's content unmodified.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getEncoded(encoding: string, charset: string): string
+
+  /**
+   * Decodes and replaces the contents with the decoded string. The `encoding` can be set to any of
+   * the following strings: `base64`, `hex`, `quoted-printable` (or `qp`), `url`, `base32`, `Q`,
+   * `B`, `url_rc1738`, `url_rfc2396`, `url_rfc3986`, `url_oauth`, `uu`, `modBase64`, or `html` (for
+   * HTML entity encoding). The full up-to-date list of supported binary encodings is available at
+   * the link entitled `Supported Binary Encodings` below.
+   *
+   * Note: This method can only be called if the encoded content decodes to a string. The `charset`
+   * indicates the charset to be used in intepreting the decoded bytes. For example, the `charset`
+   * can be `utf-8`, `utf-16`, `iso-8859-1`, `shift_JIS`, etc.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  decode(encoding: string, charset: string): void
+
+  /**
+   * Trims whitespace from both ends of the string.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  trim(): void
+
+  /**
+   * Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no
+   * occurances of more than one SPACE char in a row.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  trimInsideSpaces(): void
+
+  /**
+   * Returns `true` if the string starts with `substr`. Otherwise returns `false`. The comparison is
+   * case sensitive if `caseSensitive` is `true`, and case insensitive if `caseSensitive` is
+   * `false`.
+   */
+  startsWith(substr: string, caseSensitive: boolean): boolean
+
+  /**
+   * Returns `true` if the string ends with `substr`. Otherwise returns `false`. The comparison is
+   * case sensitive if `caseSensitive` is `true`, and case insensitive if `caseSensitive` is
+   * `false`.
+   */
+  endsWith(substr: string, caseSensitive: boolean): boolean
+
+  /**
+   * Converts the contents to lowercase.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  toLowercase(): void
+
+  /**
+   * Converts the contents to uppercase.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  toUppercase(): void
+
+  /**
+   * Converts line endings to CRLF (Windows) format.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  toCRLF(): void
+
+  /**
+   * Converts line endings to LF-only (UNIX) format.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  toLF(): void
+
+  /**
+   * Decodes HTML entities. See [HTML
+   * entities](https://duckduckgo.com/?q=html+entities&bext=wfp&ia=web) for more information about
+   * HTML entities.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  entityDecode(): void
+
+  /**
+   * Replaces all word occurrences of a specified string in this instance with another specified
+   * string. Returns the number of replacements made.
+   *
+   * Important: This method is limited to replacing whole words in strings that only contains
+   * characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only
+   * contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha
+   * chars. (The underscore character is also considered part of a word.)
+   */
+  replaceWord(value: string, replacement: string): number
+
+  /**
+   * Replaces all occurrences of `value` with `replacement`, but only where `value` is found between
+   * `beginMark` and `endMark`. Returns the number of replacements made.
+   */
+  replaceBetween(beginMark: string, endMark: string, value: string, replacement: string): number
+
+  /**
+   * Returns the substring found between the 1st occurrence of `beginMark` and the next occurrence
+   * of `endMark`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getBetween(beginMark: string, endMark: string): string
+
+  /**
+   * Begin searching after the 1st occurrence of `searchAfter` is found, and then return the
+   * substring found between the next occurrence of `beginMark` and the next occurrence of
+   * `endMark`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getAfterBetween(searchAfter: string, beginMark: string, endMark: string): string
+
+  /**
+   * Returns the Nth substring in string that is a list delimted by `delimiterChar`. The first
+   * substring is at index 0. 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 StringBuilder.lastErrorText}.
+   */
+  getNth(index: number, delimiterChar: string, exceptDoubleQuoted: boolean, exceptEscaped: boolean): string
+
+  /**
+   * Sets the Nth substring in string in a list delimted by `delimiterChar`. The first substring is
+   * at index 0. 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 StringBuilder.lastErrorText}.
+   */
+  setNth(index: number, value: string, delimiterChar: string, exceptDoubleQuoted: boolean, exceptEscaped: boolean): void
+
+  /**
+   * Loads the contents of a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  loadFile(path: string, charset: string): void
+
+  /**
+   * Writes the contents to a file. If `emitBom` is `true`, then the BOM (also known as a preamble),
+   * is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  writeFile(path: string, charset: string, emitBom: boolean): void
+
+  /**
+   * Appends the contents of another StringBuilder to this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendSb(sb: StringBuilder): void
+
+  /**
+   * Returns `true` if the contents of this object equals the `sb`. Returns `false` if unequal. For
+   * case insensitive equality, set `caseSensitive` equal to `false`.
+   */
+  contentsEqualSb(sb: StringBuilder, caseSensitive: boolean): boolean
+
+  /**
+   * Returns the last N lines of the text. If fewer than `numLines` lines exists, then all of the
+   * text is returned. If `bCrlf` is `true`, then the line endings of the returned string are
+   * converted to CRLF, otherwise the line endings are converted to LF-only.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  lastNLines(numLines: number, bCrlf: boolean): string
+
+  /**
+   * Appends the contents of `binData`. The `charset` specifies the character encoding of the bytes
+   * contained in `binData`. The `charset` can be any of the supported encodings listed at [Chilkat
+   * Supported Character Encodings](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
+   * To append the entire contents of `binData`, set `offset` and `numBytes` equal to zero. To
+   * append a range of `binData`, set the `offset` and `numBytes` to specify the range.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendBd(binData: BinData, charset: string, offset: number, numBytes: number): void
+
+  /**
+   * Replaces the first occurrence of ALL the content found between `beginMark` and `endMark` with
+   * `replacement`. The `beginMark` and `endMark` are included in what is replaced if `replaceMarks`
+   * is `true`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  replaceAllBetween(beginMark: string, endMark: string, replacement: string, replaceMarks: boolean): void
+
+  /**
+   * Appends the `str` followed by a CRLF or LF to the end of the curent StringBuilder object. If
+   * `crlf` is `true`, then a CRLF line ending is used. Otherwise a LF line ending is used.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendLine(str: string, crlf: boolean): void
+
+  /**
+   * Removes all characters from the current StringBuilder instance, and write zero bytes to the
+   * allocated memory before deallocating.
+   */
+  secureClear(): void
+
+  /**
+   * Replaces all occurrences of `value` with the decimal integer `replacement`. Returns the number
+   * of replacements.
+   */
+  replaceI(value: string, replacement: number): number
+
+  /**
+   * Returns `true` if the `word` is contained within this object, but only if it is a whole word.
+   * This method is limited to finding whole words in strings that only contains characters in the
+   * Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric
+   * chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore
+   * character is also considered part of a word.)
+   *
+   * For case sensitive matching, set `caseSensitive` equal to `true`. For case-insensitive, set
+   * `caseSensitive` equal to `false`.
+   */
+  containsWord(word: string, caseSensitive: boolean): boolean
+
+  /**
+   * In-place encodes the string to punycode.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  punyEncode(): void
+
+  /**
+   * In-place decodes the string from punycode.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  punyDecode(): void
+
+  /**
+   * Replaces the content found after the final occurrence of `marker` with `replacement`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  replaceAfterFinal(marker: string, replacement: string): void
+
+  /**
+   * Writes the contents to a file, but only if it is a new file or if the contents are different
+   * than the existing file. If `emitBom` is `true`, then the BOM (also known as a preamble), is
+   * emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  writeFileIfModified(path: string, charset: string, emitBom: boolean): void
+
+  /**
+   * Returns the substring found before the 1st occurrence of `marker`. If `removeFlag` is `true`,
+   * the content up to and including the `marker` is removed from this object's contents.
+   *
+   * If the `marker` is not present, then the entire string is returned. In this case, if
+   * `removeFlag` is `true`, this object is also cleared.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getBefore(marker: string, removeFlag: boolean): string
+
+  /**
+   * Removes the substring found before the 1st occurrence of the `marker`. Also removes the
+   * `marker`. Returns `true` if the `marker` was found and content was removed. Otherwise returns
+   * `false`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  removeBefore(marker: string): void
+
+  /**
+   * Replaces the first occurrence of a specified string in this instance with another string.
+   * Returns `true` if the `value` was found and replaced. Otherwise returns `false`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  replaceFirst(value: string, replacement: string): void
+
+  /**
+   * Returns the substring found after the final occurrence of `marker`. If `removeFlag` is `true`,
+   * the `marker` and the content that follows is removed from this content.
+   *
+   * If the `marker` is not present, then the entire string is returned. In this case, if
+   * `removeFlag` is `true`, this object is also cleared.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getAfterFinal(marker: string, removeFlag: boolean): string
+
+  /**
+   * Removes the substring found after the final occurrence of the `marker`. Also removes the
+   * `marker`. Returns `true` if the `marker` was found and content was removed. Otherwise returns
+   * `false`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  removeAfterFinal(marker: string): void
+
+  /**
+   * Obfuscates the string. (The Unobfuscate method can be called to reverse the obfuscation to
+   * restore the original string.)
+   *
+   * The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64
+   * encoding it,
+   * and then scrambling the letters of the base64 encoded string. It is deterministic in that the
+   * same string will always obfuscate to the same result. It is NOT a secure way of encrypting a
+   * string. It is only meant to be a simple means of transforming a string into something
+   * unintelligible.
+   */
+  obfuscate(): void
+
+  /**
+   * Unobfuscates the string.
+   *
+   * The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64
+   * encoding it,
+   * and then scrambling the letters of the base64 encoded string. It is deterministic in that the
+   * same string will always obfuscate to the same result. It is not a secure way of encrypting a
+   * string. It is only meant to be a simple means of transforming a string into something
+   * unintelligible.
+   */
+  unobfuscate(): void
+
+  /**
+   * Replaces all occurrences of `value` with `replacement` (case insensitive). Returns the number
+   * of replacements.
+   */
+  replaceNoCase(value: string, replacement: string): number
+
+  /**
+   * Decodes a binary encoded string, where the binary encoding (such as `url`, `hex`, `base64`,
+   * etc.) is specified by `encoding`, and the underlying charset encoding (such as `utf-8`,
+   * `windows-1252`, etc.) is specified by `charset`. The decoded string is appended to this object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  decodeAndAppend(value: string, encoding: string, charset: string): void
+
+  /**
+   * Shortens the string by removing the last `numChars` chars.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  shorten(numChars: number): void
+
+  /**
+   * Removes the specified range of characters from this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  removeCharsAt(startIndex: number, numChars: number): void
+
+  /**
+   * Returns a string containing the specified range of characters from this instance. If
+   * `removeFlag` is `true`, then the range of chars is removed from this instance.
+   *
+   * Note: It was discovered that the range of chars was always removed regardless of the value of
+   * `removeFlag`. This is fixed in v9.5.0.89.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getRange(startIndex: number, numChars: number, removeFlag: boolean): string
+
+  /**
+   * Returns the hash of the contents of this object. The `algorithm` is the hash algorithm, and can
+   * be `sha1`, `sha256`, `sha384`, `sha512`, `sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `md2`,
+   * `md5`, `ripemd128`, `ripemd160`,`ripemd256`, or `ripemd320`.
+   * The `encoding` can be `base64`, `modBase64`, `base64Url`, `base32`, `base58`, `qp` (for
+   * quoted-printable), `url` (for url-encoding), `hex`, `hexLower`, or any of the encodings found
+   * at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).
+   *
+   * The `charset` is the character encoding byte representation to hash. It is typically `utf-8`.
+   * It can be any of the chacter encodings listed at [Chilkat Character Encodings
+   * List](https://www.chilkatsoft.com/charsets_supported_by_chilkat.asp).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getHash(algorithm: string, encoding: string, charset: string): string
+
+  /**
+   * Removes the accents (diacritics) from European accented characters. This applies only to the
+   * accented characters found in the Windows-1252 (Latin alphabet) and Windows-1250 (Central
+   * European) charsets. Accent marks for characters in other languages will not be removed.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  removeAccents(): void
+
+  /**
+   * Generates and appends a random GUID/UUID such as 63c35f38-2b5f-4600-b3da-3ddee86d62b3. If
+   * `lowerCase` is `true`, then the hex values use lowercase (`a` - `f`). If `lowerCase` is `false`
+   * then uppercase is used (`A` - `F`).
+   *
+   * Note: This generates a version 4 UUID.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendUuid(lowerCase: boolean): void
+
+  /**
+   * Append `numBytes` random bytes encoded according to `encoding`. `encoding` can be `hex`,
+   * `hex_lower`, `base64`, `base64url`, or any other encoding supported by Chilkat.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendRandom(numBytes: number, encoding: string): void
+
+  /**
+   * Generates and appends a random version 7 UUID. If `lowerCase` is `true`, then the hex values
+   * use lowercase (`a` - `f`). If `lowerCase` is `false` then uppercase is used (`A` - `F`).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendUuid7(lowerCase: boolean): void
+
+  /**
+   * Removes all emoji characters from the string.
+   */
+  removeEmojis(): void
+
+  /**
+   * Searches the content of this object for substrings that match a regular expression pattern and
+   * returns the matches in `json`. Returns the number of matches or -1 for failure. `timeoutMs` is
+   * the maximum number of milliseconds of processing allowed before giving up. Pass 0 for an
+   * infinite amount of time. Failure information is also returned in `json`.
+   */
+  regexMatch(pattern: string, json: JsonObject, timeoutMs: number): number
+
+  /**
+   * Replaces the substrings of capture groups found in a previous call to RegexMatch.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  regexReplace(json: JsonObject): void
+
+  /**
+   * This function masks the content inside single and/or double-quoted strings by replacing it with
+   * a specified mask character (`maskChar`). The content of each masked quoted string is saved to
+   * `maskedStrings`. The contents can be restored by calling RestoreMaskedStrings.
+   *
+   * `quoteType` determines which types of quoted strings are masked:
+   *
+   * - Both single and double quoted.
+   *
+   * - Only single quoted strings.
+   *
+   * - Only double quoted strings.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  maskQuotedStrings(maskChar: string, quoteType: number, maskedStrings: StringTable): void
+
+  /**
+   * Restores single and/or double-quoted strings previously masked by MaskQuotedStrings.
+   *
+   * `quoteType` determines which types of quoted strings are masked:
+   *
+   * - Both single and double quoted.
+   *
+   * - Only single quoted strings.
+   *
+   * - Only double quoted strings.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  restoreMaskedStrings(quoteType: number, maskedStrings: StringTable): void
+
+  /**
+   * This method converts the Markdown content of this object to HTML, storing the result in
+   * `sbHtml`. It supports both streaming and full document conversion. `options` specifies
+   * conversion options, including a key `streaming` option. In `streaming` mode, generated HTML is
+   * appended to `sbHtml`. In non-streaming mode, `sbHtml` is fully replaced by the generated HTML.
+   * For further details, see the examples linked below.
+   *
+   * In `streaming` mode, only complete markdown lines are converted to HTML and removed from this
+   * object, leaving just the final partial line, if present. If this object contains only a partial
+   * markdown line, no HTML is emitted.
+   *
+   * Starting in `v11.3.0` ...
+   *
+   * - `"emitJavascript": true` can be included in `options` to emit Javascript function calls
+   *   instead of HTML. This is used to update the response in an embedded browser in real-time. See
+   *   [Real-Time Streaming AI Responses to Embedded Browsers in Desktop
+   *   Apps](https://www.chilkatsoft.com/ai_real_time_ui_streaming.asp)
+   *
+   * - `"streamingShell": true` is used to convert an empty string to an HTML shell to be used as
+   *   the starting point before applying Javascript function calls. See [Preparing the HTML
+   *   Shell](https://www.chilkatsoft.com/preparing_the_html_shell.asp)
+   *
+   * - `"theme": "html_theme_name"` can be included when creating the HTML shell to select a
+   *   predefined theme or when converting Markdown to HTML in non-streaming mode. The available
+   *   themes are:
+   *
+   * - ChatGPT - A style that is similar to the ChatGPT application.
+   *
+   * - cleanWin - A clean style for Windows applications.
+   *
+   * - cleanMac - A clean style for MacOS applications.
+   *
+   * - raw - No HTML styles, header, or body begin/end elements are emitted. Only the Markdown to
+   *   HTML generated elements are emitted.
+   *
+   * If no `theme` is is included, then default HTML docType/root/body/header elements are emitted
+   * unless various parts are overridden by `docType`, `rootElement`, `head`, `bodyStart`,
+   * `bodyEnd`, and `bodyExtra`.
+   *
+   * - `"usesPrism": true` can be included when creating the HTML shell (or when converting Markdown
+   *   to HTML in non-streaming mode) to include [PRISM code highlighting](https://prismjs.com/).
+   *
+   * - `"prism": { "theme": "prism_theme_name" }` Is optional and can be used to specify the prism
+   *   theme when `usesPrism` is `true`. Possible values are:
+   *
+   * - tomorrow
+   *
+   * - default
+   *
+   * - coy
+   *
+   * - dark
+   *
+   * - funky
+   *
+   * - okaidia
+   *
+   * - solarizedlight
+   *
+   * - twilight
+   *
+   * - `"prism": { "version": "version_number" }` Is optional can can be used to specify the prism
+   *   version, such as `"1.29.0"` when `usesPrism` is `true`. If not specified, then "1.29.0" is
+   *   used.
+   *
+   * - If no `theme` is specified, then any or all of the following HTML document parts can be
+   *   explicitly specified:
+   *
+   * - `"docType": "doctype_element"` The `DOCTYPE` element.  The default is `"_LT_!DOCTYPE html>"`
+   *
+   * - `"rootElement": "root_element"` The `html` element.  The default is `"_LT_html>"`
+   *
+   * - `"head": "head_section"` The HTML fragment for the HTML head section. The default is
+   *   `"_LT_head>_LT_meta charset="utf-8" />_LT_/head>"`.
+   *   Note: If `usesPrism` is `true`, then prism related links will be inserted just before the
+   *   `_LT_/head>`.
+   *
+   * - `"bodyStart": "html_fragment"` The HTML fragment to begin the body section. The default is
+   *   `"_LT_body>_LT_div id="content">"`
+   *
+   * - `"bodyEnd": "html_fragment"` The HTML fragment to end the body section. The default is
+   *   `"_LT_/div>_LT_!-- end-of-content-div -->_LT_/body>"`
+   *
+   * - `"noContentDiv": true` If set, the default bodyStart and bodyEnd do not include the `"_LT_div
+   *   id="content">"` and `"_LT_/div>_LT_!-- end-of-content-div -->"`
+   *
+   * - `"copyButton": true` In non-streaming mode, can optionally be set to include HTML for adding
+   *   a copy button. THe copy button is added by default in streaming mode.
+   *
+   * - `"ChatGPT": { "max-width": "css_length"; }` Is optional can can be used to specify the max
+   *   width of the body text if the `theme` is `ChatGPT`. The css_length is a length using CSS
+   *   length units, such as `"72ch"`, `"40em"`, `"800px"`, etc.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  markdownToHtml(options: JsonObject, sbHtml: StringBuilder): void
+
+  /**
+   * Appends to `startIndex` the specified range of characters from this instance. If `removeFlag`
+   * is `true`, then the range of chars is removed from this instance.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  getRangeSb(startIndex: number, numChars: number, removeFlag: boolean, sb: StringBuilder): void
+
+  /**
+   * Appends the `str` followed by a CRLF to the end of this object. This method is the same as
+   * {@link StringBuilder.appendLine}, except the line-ending is always CRLF.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link StringBuilder.lastErrorText}.
+   */
+  appendLn(str: string): void
+}