@chilkat/react-native 11.6.1

package/src/specs/Stream.nitro.ts

@@ -0,0 +1,737 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+
+/**
+ * Read, write, pipe, monitor, and control byte or text streams.
+ *
+ * `Stream` is a general-purpose streaming object for moving
+ * data between sources and sinks without requiring the entire payload to be
+ * handled at once. A stream can read from files, byte arrays, strings, or other
+ * sources; write to files, memory, `BinData`,
+ * `StringBuilder`, or other sinks; handle binary and text data;
+ * apply character-set rules for strings; process file parts; track bytes sent
+ * and received; and support timeouts, polling, aborts, async task integration,
+ * and end-of-stream handling.
+ *
+ * **File and memory sources**
+ *
+ * Stream from a source file, byte array, string, or selected file part
+ * without manually loading or copying all data first.
+ *
+ * **File and object sinks**
+ *
+ * Write streamed data to a sink file, append to an existing file, or output
+ * to `BinData`, `StringBuilder`, bytes, or strings.
+ *
+ * **Binary reads and writes**
+ *
+ * Read or write raw bytes, fixed byte counts, encoded byte strings,
+ * individual bytes, or `BinData` content.
+ *
+ * **Text streaming**
+ *
+ * Read and write strings using `StringCharset`, optionally use a
+ * BOM, and read text until CRLF or a matching delimiter.
+ *
+ * **Timeouts and polling**
+ *
+ * Control read and write wait behavior, poll for immediately available
+ * data, and inspect read or write failure reasons.
+ *
+ * **Progress and lifecycle**
+ *
+ * Track bytes sent and received, detect end-of-stream or write-closed
+ * state, reset streams, close writing, and abort long-running operations.
+ *
+ * **Common pattern:**
+ * Configure the stream's source and sink, set the character set or chunk size
+ * if needed, then read or write using the method that matches the data type:
+ * bytes, encoded bytes, strings, `BinData`, or
+ * `StringBuilder`. Check `EndOfStream`,
+ * `ReadFailReason`, `WriteFailReason`,
+ * `NumReceived`, `NumSent`, and
+ * `LastErrorText` to understand stream progress and failures.
+ *
+ * **Timeout note:**
+ * For `ReadTimeoutMs`, a value of `0` means a polling
+ * read, not an infinite timeout. For `WriteTimeoutMs`,
+ * `0` means return immediately if the stream cannot be written to
+ * right away.
+ *
+ * Each `Stream` 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 Stream()`.
+ *
+ * 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 Stream.abort} and assigning {@link Stream.onPercentDone} / {@link Stream.onProgressInfo}.
+ */
+export interface Stream 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
+
+  /**
+   * When set to `true`, causes the currently running method to abort. Methods that always finish
+   * quickly (i.e.have no length file operations or network communications) are not affected. If no
+   * method is running, then this property is automatically reset to `false` when the next method is
+   * called. When the abort occurs, this property is reset to `false`. Both synchronous and
+   * asynchronous method calls can be aborted. (A synchronous method call could be aborted by
+   * setting this property from a separate thread.)
+   */
+  abortCurrent: boolean
+
+  /**
+   * `true` if the stream supports reading.  Otherwise `false`.
+   *
+   * **Note: **A stream that supports reading, which has already reached the end-of-stream, will
+   * still have a CanRead value of `true`. This property indicates the stream's inherent ability,
+   * and not whether or not the stream can be read at a particular moment in time.
+   *
+   * This property is read-only.
+   */
+  readonly canRead: boolean
+
+  /**
+   * `true` if the stream supports writing.  Otherwise `false`.
+   *
+   * **Note: **A stream that supports writing, which has already been closed for write, will still
+   * have a CanWrite value of `true`. This property indicates the stream's inherent ability, and not
+   * whether or not the stream can be written at a particular moment in time.
+   *
+   * This property is read-only.
+   */
+  readonly canWrite: boolean
+
+  /**
+   * `true` if it is known for sure that data is ready and waiting to be read. `false` if it is not
+   * known for sure (it may be that data is immediately available, but reading the stream with a
+   * ReadTimeoutMs of 0, which is to poll the stream, is the way to find out).
+   *
+   * This property is read-only.
+   */
+  readonly dataAvailable: boolean
+
+  /**
+   * The default internal chunk size for reading or writing. The default value is 65536. If this
+   * property is set to 0, it will cause the default chunk size (65536) to be used. Note: The chunk
+   * size can have significant performance impact. If performance is an issue, be sure to experiment
+   * with different chunk sizes.
+   */
+  defaultChunkSize: number
+
+  /**
+   * `true` if the end-of-stream has already been reached. When the stream has already ended, all
+   * calls to Read\* methods will return `false` with the ReadFailReason set to 3 (already at
+   * end-of-stream).
+   *
+   * This property is read-only.
+   */
+  readonly endOfStream: boolean
+
+  /**
+   * `true` if the stream is closed for writing. Once closed, no more data may be written to the
+   * stream.
+   *
+   * This property is read-only.
+   */
+  readonly isWriteClosed: boolean
+
+  /**
+   * The length (in bytes) of the stream's source. If unknown, then this property will have a value
+   * of -1. This property may be set by the application if it knows in advance the length of the
+   * stream.
+   *
+   * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
+   */
+  length: number
+
+  /**
+   * The length (in bytes) of the stream's source. If unknown, then this property will have a value
+   * of -1. This property may be set by the application if it knows in advance the length of the
+   * stream.
+   *
+   * Setting this property also sets the Length property (which is a 64-bit integer).
+   */
+  length32: number
+
+  /**
+   * The number of bytes received by the stream.
+   *
+   * This property is read-only.
+   *
+   * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
+   */
+  readonly numReceived: number
+
+  /**
+   * The number of bytes sent by the stream.
+   *
+   * This property is read-only.
+   *
+   * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
+   */
+  readonly numSent: number
+
+  /**
+   * This property is automatically set when a Read\* method is called. It indicates the reason for
+   * failure. Possible values are:
+   *
+   * - No failure (success)
+   *
+   * - Timeout, or no data is immediately available for a polling read.
+   *
+   * - Aborted by an application callback.
+   *
+   * - Already at end-of-stream.
+   *
+   * - Fatal stream error.
+   *
+   * - Out-of-memory error (this is very unlikely).
+   *
+   * This property is read-only.
+   */
+  readonly readFailReason: number
+
+  /**
+   * The maximum number of seconds to wait while reading. The default value is 30 seconds (i.e.
+   * 30000ms). A value of 0 indicates a poll. (A polling read is to return with a timeout if no data
+   * is immediately available.)
+   *
+   * **Important:** For most Chilkat timeout related properties, a value of 0 indicates an infinite
+   * timeout. For this property, a value of 0 indicates a poll. If setting a timeout related
+   * property (or method argument) to zero, be sure to understand if 0 means `wait forever` or
+   * `poll`.
+   *
+   * The timeout value is not a total timeout. It is the maximum time to wait while no additional
+   * data is forthcoming.
+   */
+  readTimeoutMs: number
+
+  /**
+   * Sets the sink to the path of a file. The file does not need to exist at the time of setting
+   * this property. The sink file will be automatically opened on demand, when the stream is first
+   * written.
+   *
+   * **Note:** This property takes priority over other potential sinks. Make sure this property is
+   * set to an empty string if the stream's sink is to be something else.
+   */
+  sinkFile: string
+
+  /**
+   * Sets the source to the path of a file. The file does not need to exist at the time of setting
+   * this property. The source file will be automatically opened on demand, when the stream is first
+   * read.
+   *
+   * **Note:** This property takes priority over other potential sources. Make sure this property is
+   * set to an empty string if the stream's source is to be something else.
+   */
+  sourceFile: string
+
+  /**
+   * If `true`, then include the BOM when creating a string source via SetSourceString where the
+   * charset is utf-8, utf-16, etc. (The term `BOM` stands for Byte Order Mark, also known as the
+   * preamble.) Also, if `true`, then include the BOM when writing a string via the WriteString
+   * method. The default value of this property is `false`.
+   */
+  stringBom: boolean
+
+  /**
+   * Indicates the expected character encoding, such as utf-8, windows-1256, utf-16, etc. for
+   * methods that read text such as: ReadString, ReadToCRLF, ReadUntilMatch. Also controls the
+   * character encoding when writing strings with the WriteString method. The supported charsets are
+   * indicated at the link below.
+   *
+   * The default value is `utf-8`.
+   */
+  stringCharset: string
+
+  /**
+   * This property is automatically set when a Write\* method is called. It indicates the reason for
+   * failure. Possible values are:
+   *
+   * - No failure (success)
+   *
+   * - Timeout, or unable to immediately write when the WriteTimeoutMs is 0.
+   *
+   * - Aborted by an application callback.
+   *
+   * - The stream has already ended.
+   *
+   * - Fatal stream error.
+   *
+   * - Out-of-memory error (this is very unlikely).
+   *
+   * This property is read-only.
+   */
+  readonly writeFailReason: number
+
+  /**
+   * The maximum number of seconds to wait while writing. The default value is 30 seconds (i.e.
+   * 30000ms). A value of 0 indicates to return immediately if it is not possible to write to the
+   * sink immediately.
+   */
+  writeTimeoutMs: number
+
+  /**
+   * If the source is a file, then this property can be used to stream one part of the file.
+   * The SourceFilePartSize property defines the size (in bytes) of each part. The SourceFilePart
+   * and SourceFilePartSize have default values of 0, which means the entire SourceFile is streamed.
+   *
+   * This property is a 0-based index. For example, if the SourceFilePartSize is 1000, then part 0
+   * is for bytes 0 to 999, part 1 is for bytes 1000 to 1999, etc.
+   */
+  sourceFilePart: number
+
+  /**
+   * If the source is a file, then this property, in conjunction with the SourceFilePart property,
+   * can be used to stream a single part of the file.
+   * This property defines the size (in bytes) of each part. The SourceFilePart and
+   * SourceFilePartSize have default values of 0, which means that by default, the entire SourceFile
+   * is streamed.
+   */
+  sourceFilePartSize: number
+
+  /**
+   * If `true`, the stream appends to the SinkFile rather than truncating and re-writing the sink
+   * file. The default value is `false`.
+   */
+  sinkFileAppend: boolean
+
+  /**
+   * The interval in milliseconds between each `AbortCheck` event callback, which enables an
+   * application to abort certain method calls before they complete. **By default, HeartbeatMs is
+   * set to **`0`**, meaning no AbortCheck event callbacks will trigger.**
+   */
+  heartbeatMs: number
+
+  // ---- Methods ----
+
+  /**
+   * The same as ReadBytes, except returns the received bytes in encoded string form. The `encoding`
+   * argument indicates the encoding, which can be `base64`, `hex`, or any of the multitude of
+   * encodings indicated in the link below.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readBytesENCAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readBytesENC(encoding: string): string
+
+  /**
+   * Asynchronous form of {@link Stream.readBytesENC}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readBytesENCAsync(encoding: string): Promise<string>
+
+  /**
+   * The same as ReadNBytes, except returns the received bytes in encoded string form. The
+   * `encoding` argument indicates the encoding, which can be `base64`, `hex`, or any of the
+   * multitude of encodings indicated in the link below.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readNBytesENCAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readNBytesENC(numBytes: number, encoding: string): string
+
+  /**
+   * Asynchronous form of {@link Stream.readNBytesENC}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readNBytesENCAsync(numBytes: number, encoding: string): Promise<string>
+
+  /**
+   * Read as much data as is immediately available on the stream. If no data is immediately
+   * available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is returned
+   * as a string. The incoming bytes are interpreted according to the StringCharset property. For
+   * example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to
+   * calling ReadString.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readStringAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readString(): string
+
+  /**
+   * Asynchronous form of {@link Stream.readString}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readStringAsync(): Promise<string>
+
+  /**
+   * Reads the stream until a CRLF is received. If no data is immediately available, it waits up to
+   * ReadTimeoutMs milliseconds for data to arrive. The data is returned as a string. The incoming
+   * bytes are interpreted according to the StringCharset property. For example, if utf-8 bytes are
+   * expected, then StringCharset should be set to `utf-8` prior to calling ReadString.
+   *
+   * Note: If the end-of-stream is reached prior to receiving the CRLF, then the remaining data is
+   * returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file). This is
+   * the only case where as string would be returned that does not end with CRLF.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readToCRLFAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readToCRLF(): string
+
+  /**
+   * Asynchronous form of {@link Stream.readToCRLF}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readToCRLFAsync(): Promise<string>
+
+  /**
+   * Reads the stream until the string indicated by `matchStr` is received. If no data is
+   * immediately available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data
+   * is returned as a string. The incoming bytes are interpreted according to the StringCharset
+   * property. For example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8`
+   * prior to calling ReadString.
+   *
+   * Note: If the end-of-stream is reached prior to receiving the match string, then the remaining
+   * data is returned, and the ReadFailReason property will be set to 3 (to indicate end-of-file).
+   * This is the only case where as string would be returned that does not end with the desired
+   * match string.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readUntilMatchAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readUntilMatch(matchStr: string): string
+
+  /**
+   * Asynchronous form of {@link Stream.readUntilMatch}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readUntilMatchAsync(matchStr: string): Promise<string>
+
+  /**
+   * Resets the stream. If a source or sink is open, then it is closed. Properties such as
+   * EndOfStream and IsWriteClose are reset to default values.
+   */
+  reset(): void
+
+  /**
+   * Sets the stream's source to the contents of `srcStr`. The `charset` indicates the character
+   * encoding to be used for the byte representation of the `srcStr`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  setSourceString(srcStr: string, charset: string): void
+
+  /**
+   * Writes a single byte to the stream.  The `byteVal` must have a value from 0 to 255.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.writeByteAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeByte(byteVal: number): void
+
+  /**
+   * Asynchronous form of {@link Stream.writeByte}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeByteAsync(byteVal: number): Promise<void>
+
+  /**
+   * Writes binary bytes to a stream. The byte data is passed in encoded string form, where the
+   * `encoding` can be `base64`, `hex`, or any of the supported binary encodings listed at the link
+   * below.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.writeBytesENCAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeBytesENC(byteData: string, encoding: string): void
+
+  /**
+   * Asynchronous form of {@link Stream.writeBytesENC}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeBytesENCAsync(byteData: string, encoding: string): Promise<void>
+
+  /**
+   * Indicates that no more data will be written to the stream.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeClose(): void
+
+  /**
+   * Writes a string to a stream. The actual bytes written are the byte representation of the string
+   * as indicated by the StringCharset property. For example, to write utf-8 bytes, first set
+   * StringCharset equal to `utf-8` and then call WriteString.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.writeStringAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeString(str: string): void
+
+  /**
+   * Asynchronous form of {@link Stream.writeString}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeStringAsync(str: string): Promise<void>
+
+  /**
+   * Read as much data as is immediately available on the stream. If no data is immediately
+   * available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The incoming data is
+   * appended to `binData`.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readBd(binData: BinData): void
+
+  /**
+   * Asynchronous form of {@link Stream.readBd}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readBdAsync(binData: BinData): Promise<void>
+
+  /**
+   * Read as much data as is immediately available on the stream. If no data is immediately
+   * available, it waits up to ReadTimeoutMs milliseconds for data to arrive. The data is appended
+   * to `sb`. The incoming bytes are interpreted according to the StringCharset property. For
+   * example, if utf-8 bytes are expected, then StringCharset should be set to `utf-8` prior to
+   * calling ReadSb.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.readSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readSb(sb: StringBuilder): void
+
+  /**
+   * Asynchronous form of {@link Stream.readSb}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  readSbAsync(sb: StringBuilder): Promise<void>
+
+  /**
+   * Writes the contents of `binData` to the stream.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.writeBdAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeBd(binData: BinData): void
+
+  /**
+   * Asynchronous form of {@link Stream.writeBd}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeBdAsync(binData: BinData): Promise<void>
+
+  /**
+   * Writes the contents of `sb` to the stream. The actual bytes written are the byte representation
+   * of the string as indicated by the StringCharset property. For example, to write utf-8 bytes,
+   * first set StringCharset equal to `utf-8` and then call WriteSb.
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Stream.writeSbAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeSb(sb: StringBuilder): void
+
+  /**
+   * Asynchronous form of {@link Stream.writeSb}: 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 Stream.abort} (which cancels it) and the {@link Stream.onPercentDone} /
+   * {@link Stream.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeSbAsync(sb: StringBuilder): Promise<void>
+
+  /**
+   * Writes binary bytes to a stream.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Stream.lastErrorText}.
+   */
+  writeBytes2(byteData: ArrayBuffer): 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 Stream.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
+}