@chilkat/react-native 11.6.1

package/src/specs/Compression.nitro.ts

@@ -0,0 +1,654 @@
+// 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 { Stream } from './Stream.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Compress and decompress bytes, text, files, and streams with a flexible API.
+ *
+ * `Compression` provides a general-purpose API for compressing
+ * and decompressing data in memory, files, and streams. It supports multiple
+ * algorithms, text charset conversion, encoded output, chunked processing, and
+ * streaming operations for large data.
+ *
+ * **Multiple algorithms**
+ *
+ * Supports `deflate`, `zlib`,
+ * `bzip2`, and `lzw`.
+ *
+ * **Flexible data types**
+ *
+ * Work with byte arrays, strings, `BinData`,
+ * `StringBuilder`, files, and streams.
+ *
+ * **Chunked processing**
+ *
+ * Process data incrementally with `FirstChunk` and
+ * `LastChunk` for chunk-aware methods.
+ *
+ * **Encoded output**
+ *
+ * Return compressed bytes as text using encodings such as
+ * `base64`, `hex`, and others.
+ *
+ * **Streaming support**
+ *
+ * Compress or decompress large files and streams with stable memory usage.
+ *
+ * **Compression + encryption**
+ *
+ * Combine compression and encryption in file workflows with integrated methods.
+ *
+ * **Tip:**
+ * For text compression, explicitly set `Charset = "utf-8"` unless
+ * another encoding is required. For encoded compressed data, set
+ * `EncodingMode` to the desired output format.
+ *
+ * For an extended overview, see
+ * [Compression Class Overview](https://www.chilkatsoft.com/compression_class_overview.asp).
+ * See also
+ * [Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp)
+ * for supported encoded output formats.
+ *
+ * Each `Compression` 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 Compression()`.
+ *
+ * Methods that can take a while (network, files, compression, key generation) also have an
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
+ * rendering. While such a call is pending, every other call on this object throws, except
+ * {@link Compression.abort} and assigning {@link Compression.onPercentDone} / {@link
+ * Compression.onProgressInfo}.
+ */
+export interface Compression 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
+
+  /**
+   * Specifies the compression algorithm to use. Supported values are
+   * `deflate`, `zlib`, `bzip2`, and `lzw`.
+   *
+   * The `zlib` option is the deflate algorithm with a zlib header.
+   *
+   * **Note:** `ppmd` is deprecated and should not be used.
+   * It was only available on 32-bit systems and specifically used the J variant.
+   * New applications should use one of the supported algorithms listed above.
+   */
+  algorithm: string
+
+  /**
+   * Specifies the character encoding used when converting text to bytes before
+   * compression, and bytes back to text after decompression.
+   *
+   * The current default is the computer’s ANSI charset, such as Windows-1252 on many
+   * Western Windows systems. However, most modern applications should explicitly set
+   * this property to `utf-8`.
+   *
+   * **Recommendation:** Set `Charset = "utf-8"` unless you
+   * specifically need compatibility with another encoding.
+   */
+  charset: string
+
+  /**
+   * Specifies the text encoding used by methods whose names end in `ENC`,
+   * such as `CompressBytesENC` and `DecompressStringENC`.
+   *
+   * Compression methods ending in `ENC` return compressed binary data as
+   * an encoded string. Decompression methods ending in `ENC` expect the
+   * input string to use this same encoding.
+   *
+   * Valid values include:
+   *
+   * - `base64`
+   *
+   * - `hex`
+   *
+   * - `url`
+   *
+   * - `quoted-printable`
+   */
+  encodingMode: string
+
+  /**
+   * Specifies the interval, in milliseconds, between `AbortCheck` event
+   * callbacks.
+   *
+   * This allows an application to periodically check whether a long-running
+   * operation should be aborted.
+   *
+   * The default value is `0`, which disables `AbortCheck`
+   * callbacks.
+   */
+  heartbeatMs: number
+
+  /**
+   * Sets the compression level used by the `deflate` and `zlib`
+   * algorithms.
+   *
+   * - `0` means no compression.
+   *
+   * - `9` means maximum compression.
+   *
+   * - The default value is `6`.
+   *
+   * Higher values may produce smaller output but can require more processing time.
+   */
+  deflateLevel: number
+
+  /**
+   * Provides a way to enable specialized or uncommon behavior. This property
+   * normally remains empty.
+   *
+   * It may be set to a comma-separated list of keywords.
+   *
+   * Supported option:
+   *
+   * -
+   * `Crypt2CompressHdr` — Duplicates the compression/decompression
+   * header behavior used by the deprecated and removed Crypt2 compression
+   * functions.
+   */
+  uncommonOptions: string
+
+  /**
+   * Indicates that the next chunk-aware compression or decompression call is the
+   * first chunk in a sequence.
+   *
+   * The default value is `_TRUE_`.
+   *
+   * When both `FirstChunk` and `LastChunk` are
+   * `_TRUE_`, the method call is treated as a complete, single-call
+   * compression or decompression operation.
+   */
+  firstChunk: boolean
+
+  /**
+   * Indicates that the next chunk-aware compression or decompression call is the
+   * final chunk in a sequence.
+   *
+   * The default value is `_TRUE_`.
+   *
+   * When both `FirstChunk` and `LastChunk` are
+   * `_TRUE_`, the input is treated as the complete data set and processed
+   * in a single call.
+   */
+  lastChunk: boolean
+
+  // ---- Methods ----
+
+  /**
+   * Compresses a source file and writes the compressed data to a destination file.
+   *
+   * The file is processed internally in streaming mode, allowing files of any size
+   * to be compressed with stable memory usage.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressFile(srcPath: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressFile}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressFileAsync(srcPath: string, destPath: string): Promise<void>
+
+  /**
+   * Compresses data from a stream source and writes the compressed data to the
+   * stream sink.
+   *
+   * The operation is performed in streaming mode, making it suitable for very large
+   * or even continuous streams while maintaining stable memory usage.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressStreamAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressStream(strm: Stream): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressStream}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressStreamAsync(strm: Stream): Promise<void>
+
+  /**
+   * Compresses a string and returns the compressed result as an encoded string.
+   *
+   * The string is first converted to bytes using `Charset`, then
+   * compressed, and finally encoded according to `EncodingMode`.
+   *
+   * This method is not `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressStringENCAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressStringENC(str: string): string
+
+  /**
+   * Asynchronous form of {@link Compression.compressStringENC}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressStringENCAsync(str: string): Promise<string>
+
+  /**
+   * Decompresses a source file and writes the decompressed data to a destination
+   * file.
+   *
+   * The file is processed internally in streaming mode, allowing files of any size
+   * to be decompressed without loading the entire file into memory.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressFile(srcPath: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link Compression.decompressFile}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressFileAsync(srcPath: string, destPath: string): Promise<void>
+
+  /**
+   * Decompresses data from a stream source and writes the decompressed data to the
+   * stream sink.
+   *
+   * The operation is performed in streaming mode, making it suitable for very large
+   * or continuous streams while maintaining stable memory usage.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressStreamAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressStream(strm: Stream): void
+
+  /**
+   * Asynchronous form of {@link Compression.decompressStream}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressStreamAsync(strm: Stream): Promise<void>
+
+  /**
+   * Decompresses compressed data supplied as an encoded string and returns the
+   * resulting text.
+   *
+   * The input string is decoded according to `EncodingMode`, then
+   * decompressed. The resulting bytes are converted to text using
+   * `Charset`.
+   *
+   * This method is not `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressStringENCAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressStringENC(encodedCompressedData: string): string
+
+  /**
+   * Asynchronous form of {@link Compression.decompressStringENC}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressStringENCAsync(encodedCompressedData: string): Promise<string>
+
+  /**
+   * Compresses the data contained in a `BinData` object.
+   *
+   * The `BinData` object is modified to contain the compressed result.
+   *
+   * This method is not `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressBd(bd: BinData): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressBd}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressBdAsync(bd: BinData): Promise<void>
+
+  /**
+   * Decompresses the compressed data contained in a `BinData` object.
+   *
+   * The `BinData` object is modified to contain the decompressed result.
+   *
+   * This method is not `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressBd(bd: BinData): void
+
+  /**
+   * Asynchronous form of {@link Compression.decompressBd}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressBdAsync(bd: BinData): Promise<void>
+
+  /**
+   * Compresses the text contained in a `StringBuilder` and appends the
+   * compressed bytes to a `BinData` object.
+   *
+   * Text is converted to bytes according to the `Charset` property.
+   *
+   * This method is `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressSb(sb: StringBuilder, binData: BinData): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressSb}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressSbAsync(sb: StringBuilder, binData: BinData): Promise<void>
+
+  /**
+   * Decompresses compressed data from a `BinData` object and appends the
+   * resulting text to a `StringBuilder`.
+   *
+   * The decompressed bytes are converted to text using the `Charset`
+   * property.
+   *
+   * This method is `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressSb(binData: BinData, sb: StringBuilder): void
+
+  /**
+   * Asynchronous form of {@link Compression.decompressSb}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressSbAsync(binData: BinData, sb: StringBuilder): Promise<void>
+
+  /**
+   * Compresses and encrypts a file, writing the result to a destination file.
+   *
+   * The compression and encryption are performed internally in streaming mode, so
+   * files of any size can be processed without loading the entire file into memory.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressEncryptFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressEncryptFile(cryptParams: JsonObject, srcPath: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressEncryptFile}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressEncryptFileAsync(cryptParams: JsonObject, srcPath: string, destPath: string): Promise<void>
+
+  /**
+   * Decrypts and decompresses a file, writing the restored data to a destination
+   * file.
+   *
+   * This is the reverse operation of `CompressEncryptFile`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decryptDecompressFileAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decryptDecompressFile(cryptParams: JsonObject, srcPath: string, destPath: string): void
+
+  /**
+   * Asynchronous form of {@link Compression.decryptDecompressFile}: the same call on a native
+   * worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decryptDecompressFileAsync(cryptParams: JsonObject, srcPath: string, destPath: string): Promise<void>
+
+  /**
+   * Compresses the data in one `BinData` object and appends the
+   * compressed output to another `BinData` object.
+   *
+   * The input `BinData` is not modified.
+   *
+   * This method is `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.compressBd2Async}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressBd2(bdIn: BinData, bdOut: BinData): void
+
+  /**
+   * Asynchronous form of {@link Compression.compressBd2}: the same call on a native worker thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  compressBd2Async(bdIn: BinData, bdOut: BinData): Promise<void>
+
+  /**
+   * Decompresses the data in one `BinData` object and appends the
+   * decompressed output to another `BinData` object.
+   *
+   * The input `BinData` is not modified.
+   *
+   * This method is `FirstChunk` / `LastChunk` aware.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Compression.decompressBd2Async}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressBd2(bdIn: BinData, bdOut: BinData): void
+
+  /**
+   * Asynchronous form of {@link Compression.decompressBd2}: the same call on a native worker
+   * thread,
+   * settling on the JavaScript thread. While it is pending, other calls on this object throw,
+   * except {@link Compression.abort} (which cancels it) and the {@link Compression.onPercentDone} /
+   * {@link Compression.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Compression.lastErrorText}.
+   */
+  decompressBd2Async(bdIn: BinData, bdOut: BinData): Promise<void>
+
+  // ---- Events (ReactNativeGen_DESIGN.md §6) ----
+
+  /**
+   * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
+   * can measure progress. Runs on the JavaScript thread, so it is only useful with the
+   * `...Async` methods (during a synchronous call the thread is busy and the events arrive
+   * after it returns). Assign `undefined` to remove.
+   */
+  onPercentDone?: (pctDone: number) => void
+
+  /**
+   * Called with a name/value pair of progress information while a long-running method runs
+   * (what is reported depends on the class and method). Runs on the JavaScript thread; see
+   * {@link Compression.onPercentDone}. Assign `undefined` to remove.
+   */
+  onProgressInfo?: (name: string, value: string) => void
+
+  /**
+   * Requests that the pending `...Async` call on this object stop at its next progress check.
+   * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
+   * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
+   * for a responsive cancel. Harmless when nothing is pending.
+   */
+  abort(): void
+}