web-csv-toolbox 0.10.3-next-ee4125d4c2daeac2840037eddcc4335c766a489a → 0.11.0-next-3e76d727a5e0c4f1fbd537e0a89bed474495294b

package/dist/types/common/types.d.ts

@@ -75,6 +75,58 @@ export interface RecordDelimiterToken {
  * @category Types
  */
 export type Token = FieldToken | FieldDelimiterToken | RecordDelimiterToken;
+/**
+ * AbortSignal Options.
+ *
+ * @category Types
+ */
+export interface AbortSignalOptions {
+    /**
+     * The signal to abort the operation.
+     *
+     * @remarks
+     *
+     * If the signal is aborted, the operation will be stopped.
+     *
+     * @example Abort with user action
+     *
+     * ```ts
+     * const controller = new AbortController();
+     *
+     * const csv = "foo,bar\n1,2\n3,4";
+     * try {
+     *   const result = await parse(csv, { signal: controller.signal });
+     * } catch (e) {
+     *   if (e instanceof DOMException && e.name === "AbortError") {
+     *     console.log("Aborted");
+     *   }
+     * }
+     *
+     * // Abort with user action
+     * document.getElementById("cancel-button")
+     *  .addEventListener("click", () => {
+     *    controller.abort();
+     *   });
+     * ```
+     *
+     * @example Abort with timeout
+     *
+     * ```ts
+     * const csv = "foo,bar\n1,2\n3,4";
+     *
+     * try {
+     *   const result = await parse(csv, { signal: AbortSignal.timeout(1000) });
+     * } catch (e) {
+     *   if (e instanceof DOMException && e.name === "TimeoutError") {
+     *     console.log("Timeout");
+     *   }
+     * }
+     * ```
+     *
+     * @default undefined
+     */
+    signal?: AbortSignal;
+}
 /**
  * CSV Common Options.
  * @category Types
@@ -167,7 +219,7 @@ export interface BinaryOptions {
  * If you don't specify `header`,
  * the first record will be treated as a header.
  */
-export interface RecordAssemblerOptions<Header extends ReadonlyArray<string>> {
+export interface RecordAssemblerOptions<Header extends ReadonlyArray<string>> extends AbortSignalOptions {
     /**
      * CSV header.
      *
@@ -186,7 +238,7 @@ export interface RecordAssemblerOptions<Header extends ReadonlyArray<string>> {
  * Parse options for CSV string.
  * @category Types
  */
-export interface ParseOptions<Header extends ReadonlyArray<string>> extends CommonOptions, RecordAssemblerOptions<Header> {
+export interface ParseOptions<Header extends ReadonlyArray<string>> extends CommonOptions, RecordAssemblerOptions<Header>, AbortSignalOptions {
 }
 /**
  * Parse options for CSV binary.