@chilkat/react-native 11.6.1

package/src/specs/Upload.nitro.ts

@@ -0,0 +1,623 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+
+/**
+ * Upload files with HTTP POST, form fields, headers, progress tracking, and TLS control.
+ *
+ * `Upload` sends files to a web server using HTTP POST,
+ * typically as a multipart/form-data upload. It supports one or more file
+ * references, custom form parameters, custom HTTP headers, blocking and
+ * asynchronous uploads, progress monitoring, upload throttling, Basic HTTP
+ * authentication, proxy settings, HTTPS/TLS configuration, timeout control, and
+ * inspection of the HTTP response returned by the server.
+ *
+ * **File upload requests**
+ *
+ * Add one or more local file references and send them to a server endpoint
+ * using HTTP POST.
+ *
+ * **Form parameters**
+ *
+ * Add ordinary form fields alongside file parts when the server expects
+ * metadata, tokens, IDs, or other POST parameters.
+ *
+ * **Custom headers**
+ *
+ * Include application-specific HTTP headers for authorization schemes,
+ * API requirements, content negotiation, or server-side routing.
+ *
+ * **Blocking or async upload**
+ *
+ * Use a simple blocking upload, begin an upload in the background, or use
+ * async task-based workflows where supported.
+ *
+ * **Progress and throttling**
+ *
+ * Monitor bytes sent, percent uploaded, current filename, upload state,
+ * and optionally throttle upload bandwidth.
+ *
+ * **Authentication, proxy, and TLS**
+ *
+ * Configure Basic authentication, HTTP/SOCKS proxy settings, HTTPS/TLS
+ * behavior, cipher restrictions, protocol versions, and certificate pinning.
+ *
+ * **Common pattern:**
+ * Set the server `Hostname`, `Port`, `Ssl`,
+ * and upload `Path`, add file references with
+ * `AddFileReference`, add any form parameters or headers, then call
+ * `BlockingUpload` or start an asynchronous upload. After completion,
+ * inspect `ResponseStatus`, `ResponseHeader`,
+ * `ResponseBody`, and `LastErrorText` to determine what
+ * the server returned.
+ *
+ * For an extended overview, see
+ * [Upload Class Overview](https://www.chilkatsoft.com/upload_class_overview.asp).
+ *
+ * Each `Upload` 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 Upload()`.
+ *
+ * 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 Upload.abort} and assigning {@link Upload.onPercentDone} / {@link Upload.onProgressInfo}.
+ */
+export interface Upload 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
+
+  /**
+   * If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of
+   * bytes per second. The default value of this property is 0.
+   */
+  bandwidthThrottleUp: number
+
+  /**
+   * The chunk size (in bytes) used by the underlying TCP/IP sockets for uploading files. The
+   * default value is 65535.
+   */
+  chunkSize: number
+
+  /**
+   * The IP address to use for computers with multiple network interfaces or IP addresses.
+   * For computers with a single network interface (i.e. most computers), this property should not
+   * be set. For multihoming computers, the default IP address is automatically used if this
+   * property is not set.
+   *
+   * The IP address is a string such as in dotted notation using numbers, not domain names, such as
+   * `165.164.55.124`.
+   */
+  clientIpAddress: string
+
+  /**
+   * When `true`, the request header will included an `Expect: 100-continue` header field. This
+   * indicates that the server should respond with an intermediate response of `100 Continue` or
+   * `417 Expectation Failed` response based on the information available in the request header.
+   * This helps avoid situations such as limits on upload sizes. It allows the server to reject the
+   * upload, and then the client can abort prior to uploading the data.
+   *
+   * The default value of this property is `true`.
+   */
+  expect100Continue: 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
+
+  /**
+   * The hostname of the HTTP server that is the target of the upload. Do not include `http://` in
+   * the hostname. It can be a hostname, such as `www.chilkatsoft.com`, or an IP address, such as
+   * `168.144.70.227`.
+   */
+  hostname: string
+
+  /**
+   * A timeout in milliseconds. The default value is 30000. If the upload hangs (i.e. progress
+   * halts) for more than this time, the component will abort the upload. (It will timeout.)
+   */
+  idleTimeoutMs: number
+
+  /**
+   * The HTTP login for sites requiring authentication. Chilkat Upload supports Basic HTTP
+   * authentication.
+   */
+  login: string
+
+  /**
+   * After an upload has completed, this property contains the number of bytes sent. During
+   * asynchronous uploads, this property contains the current number of bytes sent while the upload
+   * is in progress.
+   *
+   * This property is read-only.
+   */
+  readonly numBytesSent: number
+
+  /**
+   * The HTTP password for sites requiring authentication. Chilkat Upload supports Basic HTTP
+   * authentication.
+   */
+  password: string
+
+  /**
+   * The path part of the upload URL.  Some examples:
+   *
+   * If the upload target (i.e. consumer) URL is:
+   * <http://www.freeaspupload.net/freeaspupload/testUpload.asp>, then
+   *
+   * Hostname = `www.freeaspupload.net`
+   * Path = `/freeaspupload/testUpload.asp`
+   *
+   * If the upload target URL is <https://www.chilkatsoft.com/cgi-bin/ConsumeUpload.exe>, then
+   *
+   * Hostname = `www.chilkatsoft.com`
+   * Path = `/cgi-bin/ConsumeUpload.exe`
+   */
+  path: string
+
+  /**
+   * This property is only valid in programming environment and languages that allow for event
+   * callbacks.
+   *
+   * Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks.
+   * The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a
+   * method that (1) is event enabled and (2) is such that it is possible to measure progress as a
+   * percentage completed. This property may be set to larger numbers to get more fine-grained
+   * PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks
+   * with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This
+   * property is clamped to a minimum value of 10, and a maximum value of 100000.
+   */
+  percentDoneScale: number
+
+  /**
+   * Contains the current percentage completion (0 to 100) while an asynchronous upload is in
+   * progress.
+   *
+   * This property is read-only.
+   */
+  readonly percentUploaded: number
+
+  /**
+   * The port number of the upload target (i.e. consumer) URL. The default value is 80. If SSL is
+   * used, this should be set to 443 (typically).
+   */
+  port: number
+
+  /**
+   * If `true`, then use IPv6 over IPv4 when both are supported for a particular domain. The default
+   * value of this property is `false`, which will choose IPv4 over IPv6.
+   */
+  preferIpv6: boolean
+
+  /**
+   * The domain name of a proxy host if an HTTP proxy is used. Do not include the `http://`. The
+   * domain name may be a hostname, such as `www.chilkatsoft.com`, or an IP address, such as
+   * `168.144.70.227`.
+   */
+  proxyDomain: string
+
+  /**
+   * If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy
+   * login.
+   */
+  proxyLogin: string
+
+  /**
+   * If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy
+   * password.
+   */
+  proxyPassword: string
+
+  /**
+   * The port number of a proxy server if an HTTP proxy is used.
+   */
+  proxyPort: number
+
+  /**
+   * An HTTP upload is nothing more than an HTTP POST that contains the content of the files being
+   * uploaded. Just as with any HTTP POST or GET, the server should send an HTTP response that
+   * consists of header and body.
+   *
+   * This property contains the header part of the HTTP response.
+   *
+   * This property is read-only.
+   */
+  readonly responseHeader: string
+
+  /**
+   * The HTTP response status code of the HTTP response. A list of HTTP status codes can be found
+   * here: [HTTP Response Status Codes](http://en.wikipedia.org/wiki/List_of_HTTP_status_codes).
+   *
+   * This property is read-only.
+   */
+  readonly responseStatus: number
+
+  /**
+   * Set this to `true` if the upload is to HTTPS.  For example, if the target of the upload is:
+   * **<https://www.myuploadtarget.com/consumeUpload.asp**>
+   *
+   * then set:
+   *
+   * Ssl = `true`
+   *
+   * Hostname = `www.myuploadtarget.com`
+   *
+   * Path = `/consumeupload.asp`
+   *
+   * Port = 443
+   */
+  ssl: boolean
+
+  /**
+   * The total size of the upload (in bytes). This property will become set at the beginning of an
+   * asynchronous upload. A program may monitor asynchronous uploads by tracking both NumBytesSent
+   * and PercentUploaded.
+   *
+   * This property is also set during synchronous uploads.
+   *
+   * This property is read-only.
+   */
+  readonly totalUploadSize: number
+
+  /**
+   * Set to `true` when an asynchronous upload is started. When the asynchronous upload is complete,
+   * this property becomes equal to `false`. A program will typically begin an asynchronous upload
+   * by calling BeginUpload, and then periodically checking the value of this property to determine
+   * when the upload is complete.
+   *
+   * This property is read-only.
+   */
+  readonly uploadInProgress: boolean
+
+  /**
+   * Set to `true` (success) or `false` (failed) after an asynchronous upload completes or aborts
+   * due to failure. When a program does an asynchronous upload, it will wait until UploadInProgress
+   * becomes `false`. It will then check the value of this property to determine if the upload was
+   * successful or not.
+   *
+   * This property is read-only.
+   */
+  readonly uploadSuccess: boolean
+
+  /**
+   * Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the
+   * expected SPKI fingerprints for the server certificates. If the server's certificate (sent
+   * during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake
+   * is aborted and the connection fails. The format of this string property is as follows:
+   *
+   * ```
+   * hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...
+   * ```
+   *
+   * For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:
+   *
+   * ```
+   * "sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="
+   * ```
+   *
+   * This example specifies two SPKI fingerprints:
+   *
+   * ```
+   * "sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="
+   * ```
+   *
+   * Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5,
+   * haval, ripemd128, ripemd160,ripemd256, or ripemd320.
+   *
+   * The following encodings are allowed: base64, hex, and any of the encodings indicated in the
+   * link below.
+   */
+  tlsPinSet: string
+
+  /**
+   * Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The
+   * default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers
+   * supported in Chilkat v9.5.0.55 and later are:
+   *
+   * ```
+   * TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
+   * TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
+   * TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
+   * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
+   * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
+   * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
+   * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
+   * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
+   * TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
+   * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
+   * TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
+   * TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
+   * TLS_DHE_RSA_WITH_AES_256_CBC_SHA
+   * TLS_RSA_WITH_AES_256_CBC_SHA256
+   * TLS_RSA_WITH_AES_256_GCM_SHA384
+   * TLS_RSA_WITH_AES_256_CBC_SHA
+   * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
+   * TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
+   * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
+   * TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
+   * TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
+   * TLS_DHE_RSA_WITH_AES_128_CBC_SHA
+   * TLS_RSA_WITH_AES_128_CBC_SHA256
+   * TLS_RSA_WITH_AES_128_GCM_SHA256
+   * TLS_RSA_WITH_AES_128_CBC_SHA
+   * TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
+   * TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
+   * TLS_RSA_WITH_3DES_EDE_CBC_SHA
+   * TLS_ECDHE_RSA_WITH_RC4_128_SHA
+   * TLS_RSA_WITH_RC4_128_SHA
+   * TLS_RSA_WITH_RC4_128_MD5
+   * TLS_DHE_RSA_WITH_DES_CBC_SHA
+   * TLS_RSA_WITH_DES_CBC_SHA
+   * ```
+   *
+   * To restrict SSL/TLS connections to one or more specific ciphers, set this property to a
+   * comma-separated list of ciphers such as `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
+   * TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384`. The order should be in terms of preference, with the
+   * preferred algorithms listed first. (Note that the client cannot specifically choose the
+   * algorithm is picked because it is the server that chooses. The client simply provides the
+   * server with a list from which to choose.)
+   *
+   * The property can also disallow connections with servers having certificates with RSA keys less
+   * than a certain size. By default, server certificates having RSA keys of 512 bits or greater are
+   * allowed. Add the keyword `rsa1024` to disallow connections with servers having keys smaller
+   * than 1024 bits. Add the keyword `rsa2048` to disallow connections with servers having keys
+   * smaller than 2048 bits.
+   *
+   * **Note:** Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher
+   * suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise.
+   * For example, the following keywords could be listed to allow matching ciphers: `aes256-cbc`,
+   * `aes128-cbc`, `3des-cbc`, and `rc4`. These keywords will still be recognized, but programs
+   * should be updated to explicitly list the allowed ciphers.
+   *
+   * **secure-renegotiation:** Starting in Chilkat v9.5.0.55, the keyword `secure-renegotiation` may
+   * be added to require that all renegotions be done securely (as per RFC 5746).
+   *
+   * **best-practices:** Starting in Chilkat v9.5.0.55, this property may be set to the single
+   * keyword `best-practices`. This will allow ciphers based on the current best practices. As new
+   * versions of Chilkat are released, the best practices may change. Changes will be noted here.
+   * The current best practices are:
+   *
+   * - If the server uses an RSA key, it must be 1024 bits or greater.
+   *
+   * - All renegotations must be secure renegotiations.
+   *
+   * - All ciphers using RC4, DES, or 3DES are disallowed.
+   *
+   * **Example:** The following string would restrict to 2 specific cipher suites, require RSA keys
+   * to be 1024 bits or greater, and require secure renegotiations:
+   * `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024,
+   * secure-renegotiation`
+   */
+  sslAllowedCiphers: string
+
+  /**
+   * Selects the secure protocol to be used for secure (SSL/TLS) connections.  Possible values are:
+   *
+   * default
+   *
+   * TLS 1.3
+   *
+   * TLS 1.2
+   *
+   * TLS 1.1
+   *
+   * TLS 1.0
+   *
+   * SSL 3.0
+   *
+   * TLS 1.3 or higher
+   *
+   * TLS 1.2 or higher
+   *
+   * TLS 1.1 or higher
+   *
+   * TLS 1.0 or higher
+   *
+   * The default value is `default` which will choose the, which allows for the protocol to be
+   * selected dynamically at runtime based on the requirements of the server. Choosing an exact
+   * protocol will cause the connection to fail unless that exact protocol is negotiated. It is
+   * better to choose `X or higher` than an exact protocol. The `default` is effectively `SSL 3.0 or
+   * higher`.
+   */
+  sslProtocol: string
+
+  /**
+   * 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
+
+  /**
+   * Returns the response body as a string.
+   *
+   * This property is read-only.
+   */
+  readonly responseBodyStr: string
+
+  /**
+   * The current filename being uploaded while an asynchronous upload is in progress.
+   *
+   * This property is read-only.
+   */
+  readonly currentFilename: string
+
+  // ---- Methods ----
+
+  /**
+   * May be called during an asynchronous upload to abort.
+   */
+  abortUpload(): void
+
+  /**
+   * Adds a custom HTTP header to the HTTP upload.
+   */
+  addCustomHeader(name: string, value: string): void
+
+  /**
+   * Adds a file to the list of files to be uploaded in the next call to BlockingUpload,
+   * BeginUpload, or UploadToMemory. To upload more than one file, call this method once for each
+   * file to be uploaded.
+   */
+  addFileReference(name: string, filename: string): void
+
+  /**
+   * Adds a custom HTTP request parameter to the upload.
+   */
+  addParam(name: string, value: string): void
+
+  /**
+   * Starts an asynchronous upload. Only one asynchronous upload may be in progress at a time. To
+   * achieve multiple asynchronous uploads, use multiple instances of the Chilkat Upload object.
+   * Each object instance is capable of managing a single asynchronous upload.
+   *
+   * When this method is called, a background thread is started and the asynchronous upload runs in
+   * the background. The upload may be aborted at any time by calling AbortUpload. The upload is
+   * completed (or failed) when UploadInProgress becomes `false`. At that point, the UploadSuccess
+   * property may be checked to determine success (`true`) or failure (`false`).
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Upload.lastErrorText}.
+   */
+  beginUpload(): void
+
+  /**
+   * Uploads files to a web server using HTTP. The files to be uploaded are indicated by calling
+   * AddFileReference once for each file (prior to calling this method).
+   *
+   * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
+   * {@link Upload.blockingUploadAsync}.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link Upload.lastErrorText}.
+   */
+  blockingUpload(): void
+
+  /**
+   * Asynchronous form of {@link Upload.blockingUpload}: 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 Upload.abort} (which cancels it) and the {@link Upload.onPercentDone} /
+   * {@link Upload.onProgressInfo} callbacks, which report progress while it runs.
+   *
+   * The promise rejects with an Error if the call fails; the full log is in
+   * {@link Upload.lastErrorText}.
+   */
+  blockingUploadAsync(): Promise<void>
+
+  /**
+   * Clears the internal list of files created by calls to AddFileReference.
+   */
+  clearFileReferences(): void
+
+  /**
+   * Clears the internal list of params created by calls to AddParam.
+   */
+  clearParams(): void
+
+  /**
+   * A convenience method for putting the calling process to sleep for N milliseconds. It is
+   * provided here because some programming languages do not provide this capability, and sleeping
+   * for short increments of time is helpful when doing asynchronous uploads.
+   */
+  sleepMs(millisec: number): 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 Upload.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
+}