@nicolastoulemont/std 0.6.0 → 0.7.0

package/dist/index-By6dNRc4.d.mts

@@ -0,0 +1,277 @@
+import { i as Fx } from "./fx.types-DeEWEltG.mjs";
+import { t as Result } from "./result.types-_xDAei3-.mjs";
+
+//#region src/multithread/multithread.types.d.ts
+
+/**
+ * Shared cancellation signal propagated to worker tasks.
+ *
+ * - When `null`, cooperative cancellation is unavailable in this environment.
+ * - When present, `Atomics.load(signal, 0) === 1` indicates cancellation.
+ */
+type MultithreadSignal = Int32Array<SharedArrayBuffer> | null;
+/**
+ * Cooperative cancellation context injected as the last argument in worker callbacks.
+ */
+type MultithreadCtx = {
+  readonly signal: MultithreadSignal;
+  isCancelled(): boolean;
+  throwIfCancelled(): void;
+};
+type MultithreadRuntimeUnavailableError = {
+  readonly _tag: "MultithreadRuntimeUnavailableError";
+  readonly message: string;
+  readonly cause?: unknown;
+};
+type MultithreadRuntimeAlreadyInitializedError = {
+  readonly _tag: "MultithreadRuntimeAlreadyInitializedError";
+  readonly message: string;
+};
+type MultithreadWorkerExecutionError = {
+  readonly _tag: "MultithreadWorkerExecutionError";
+  readonly message: string;
+  readonly cause: unknown;
+};
+type MultithreadCancelledError = {
+  readonly _tag: "MultithreadCancelledError";
+  readonly message: string;
+};
+type MultithreadAllFailedError = {
+  readonly _tag: "MultithreadAllFailedError";
+  readonly message: string;
+  readonly errors: readonly unknown[];
+};
+/**
+ * Canonical error union for multithread operations.
+ */
+type MultithreadError = MultithreadRuntimeUnavailableError | MultithreadRuntimeAlreadyInitializedError | MultithreadWorkerExecutionError | MultithreadCancelledError | MultithreadAllFailedError;
+/**
+ * Worker callback output shape.
+ *
+ * Worker callbacks may return either:
+ * - raw values (wrapped as `Result.ok`), or
+ * - explicit `Result` values.
+ */
+type WorkerReturn<A, E> = A | Result<A, E> | Promise<A> | Promise<Result<A, E>>;
+/**
+ * Cold, memoized operation representing one multithread execution.
+ *
+ * - `result()` is the canonical Result-first API.
+ * - `await op` works through `then`.
+ * - `yield* op` works through async iterator yieldability.
+ */
+type MultithreadOp<A, E> = Fx<A, E> & {
+  readonly _tag: "MultithreadOp";
+  result(): Promise<Result<A, E>>;
+  abort(): void;
+  then: PromiseLike<Result<A, E>>["then"];
+  [Symbol.asyncIterator](): AsyncGenerator<E, A, unknown>;
+};
+type MultithreadParallelOptions = {
+  readonly parallelism?: number;
+};
+type WorkerWithCtx<Args extends readonly unknown[], A, E> = (...args: [...Args, MultithreadCtx]) => WorkerReturn<A, E>;
+type MultithreadRun = {
+  <A, E = never>(worker: (ctx: MultithreadCtx) => WorkerReturn<A, E>): MultithreadOp<A, E | MultithreadError>;
+  <Args extends readonly unknown[], A, E = never>(worker: WorkerWithCtx<Args, A, E>, ...args: Args): MultithreadOp<A, E | MultithreadError>;
+};
+type MultithreadTask = {
+  <A, E = never>(worker: (ctx: MultithreadCtx) => WorkerReturn<A, E>): () => MultithreadOp<A, E | MultithreadError>;
+  <Args extends readonly unknown[], A, E = never>(worker: WorkerWithCtx<Args, A, E>): (...args: Args) => MultithreadOp<A, E | MultithreadError>;
+};
+type MultithreadMapWorker<A, B, E> = (value: A, index: number, ctx: MultithreadCtx) => WorkerReturn<B, E>;
+type MultithreadMap = {
+  <A, B, E = never>(values: readonly A[], worker: MultithreadMapWorker<A, B, E>, options?: MultithreadParallelOptions): MultithreadOp<readonly B[], E | MultithreadError>;
+  <A, B, E = never, InputE = never>(values: Result<readonly A[], InputE>, worker: MultithreadMapWorker<A, B, E>, options?: MultithreadParallelOptions): Promise<Result<readonly B[], E | InputE | MultithreadError>>;
+  <A, B, E = never>(worker: MultithreadMapWorker<A, B, E>, options?: MultithreadParallelOptions): <Input extends readonly A[] | Result<readonly A[], unknown>>(values: Input) => Input extends Result<readonly A[], infer InputE> ? Promise<Result<readonly B[], E | InputE | MultithreadError>> : MultithreadOp<readonly B[], E | MultithreadError>;
+};
+type MultithreadForEach = {
+  <A, E = never>(values: readonly A[], worker: MultithreadMapWorker<A, unknown, E>, options?: MultithreadParallelOptions): MultithreadOp<void, E | MultithreadError>;
+  <A, E = never, InputE = never>(values: Result<readonly A[], InputE>, worker: MultithreadMapWorker<A, unknown, E>, options?: MultithreadParallelOptions): Promise<Result<void, E | InputE | MultithreadError>>;
+  <A, E = never>(worker: MultithreadMapWorker<A, unknown, E>, options?: MultithreadParallelOptions): <Input extends readonly A[] | Result<readonly A[], unknown>>(values: Input) => Input extends Result<readonly A[], infer InputE> ? Promise<Result<void, E | InputE | MultithreadError>> : MultithreadOp<void, E | MultithreadError>;
+};
+type MultithreadFilterWorker<A, E> = (value: A, index: number, ctx: MultithreadCtx) => WorkerReturn<boolean, E>;
+type MultithreadFilter = {
+  <A, E = never>(values: readonly A[], worker: MultithreadFilterWorker<A, E>, options?: MultithreadParallelOptions): MultithreadOp<readonly A[], E | MultithreadError>;
+  <A, E = never, InputE = never>(values: Result<readonly A[], InputE>, worker: MultithreadFilterWorker<A, E>, options?: MultithreadParallelOptions): Promise<Result<readonly A[], E | InputE | MultithreadError>>;
+  <A, E = never>(worker: MultithreadFilterWorker<A, E>, options?: MultithreadParallelOptions): <Input extends readonly A[] | Result<readonly A[], unknown>>(values: Input) => Input extends Result<readonly A[], infer InputE> ? Promise<Result<readonly A[], E | InputE | MultithreadError>> : MultithreadOp<readonly A[], E | MultithreadError>;
+};
+type MultithreadFlatMapWorker<A, B, E> = (value: A, index: number, ctx: MultithreadCtx) => WorkerReturn<readonly B[] | B[], E>;
+type MultithreadFlatMap = {
+  <A, B, E = never>(values: readonly A[], worker: MultithreadFlatMapWorker<A, B, E>, options?: MultithreadParallelOptions): MultithreadOp<readonly B[], E | MultithreadError>;
+  <A, B, E = never, InputE = never>(values: Result<readonly A[], InputE>, worker: MultithreadFlatMapWorker<A, B, E>, options?: MultithreadParallelOptions): Promise<Result<readonly B[], E | InputE | MultithreadError>>;
+  <A, B, E = never>(worker: MultithreadFlatMapWorker<A, B, E>, options?: MultithreadParallelOptions): <Input extends readonly A[] | Result<readonly A[], unknown>>(values: Input) => Input extends Result<readonly A[], infer InputE> ? Promise<Result<readonly B[], E | InputE | MultithreadError>> : MultithreadOp<readonly B[], E | MultithreadError>;
+};
+type MultithreadValue<T> = T extends MultithreadOp<infer A, unknown> ? A : never;
+type MultithreadOpError<T> = T extends MultithreadOp<unknown, infer E> ? E : never;
+type MultithreadRace = {
+  <A, E>(operations: readonly MultithreadOp<A, E>[]): MultithreadOp<A, E | MultithreadError>;
+  <A, E, InputE = never>(operations: Result<readonly MultithreadOp<A, E>[], InputE>): Promise<Result<A, E | InputE | MultithreadError>>;
+  <Ops extends readonly MultithreadOp<unknown, unknown>[]>(operations: Ops): MultithreadOp<MultithreadValue<Ops[number]>, MultithreadOpError<Ops[number]> | MultithreadError>;
+  <Ops extends readonly MultithreadOp<unknown, unknown>[], InputE = never>(operations: Result<Ops, InputE>): Promise<Result<MultithreadValue<Ops[number]>, MultithreadOpError<Ops[number]> | InputE | MultithreadError>>;
+};
+type MultithreadFirstSuccess = {
+  <A, E>(operations: readonly MultithreadOp<A, E>[]): MultithreadOp<A, E | MultithreadError>;
+  <A, E, InputE = never>(operations: Result<readonly MultithreadOp<A, E>[], InputE>): Promise<Result<A, E | InputE | MultithreadError>>;
+  <Ops extends readonly MultithreadOp<unknown, unknown>[]>(operations: Ops): MultithreadOp<MultithreadValue<Ops[number]>, MultithreadOpError<Ops[number]> | MultithreadError>;
+  <Ops extends readonly MultithreadOp<unknown, unknown>[], InputE = never>(operations: Result<Ops, InputE>): Promise<Result<MultithreadValue<Ops[number]>, MultithreadOpError<Ops[number]> | InputE | MultithreadError>>;
+};
+declare namespace multithread_d_exports {
+  export { MultithreadCtx, MultithreadError, MultithreadOp, configure, filter, firstSuccess, flatMap, forEach, map, race, run, shutdown, task };
+}
+/**
+ * Execute one worker task as a cancelable `MultithreadOp`.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const op = Multithread.run((ctx) => (ctx.isCancelled() ? 0 : 42))
+ * // => cancelable operation with result() and abort()
+ * ```
+ *
+ * @category Constructors
+ */
+declare const run: MultithreadRun;
+/**
+ * Create a reusable worker task factory.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const create = Multithread.task((ctx) => (ctx.isCancelled() ? 0 : 16))
+ * const op = create()
+ * // => operation that resolves to 16 when executed
+ * ```
+ *
+ * @category Constructors
+ */
+declare const task: MultithreadTask;
+/**
+ * Map a collection in parallel.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const op = Multithread.map([1, 2, 3], (value) => value * 2)
+ * // => operation that resolves to [2, 4, 6]
+ * ```
+ *
+ * @category Mapping
+ */
+declare const map: MultithreadMap;
+/**
+ * Run side-effecting parallel work for each item.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const op = Multithread.forEach(["a", "b"], (value) => value.toUpperCase())
+ * // => operation that resolves to void after all items complete
+ * ```
+ *
+ * @category Sequencing
+ */
+declare const forEach: MultithreadForEach;
+/**
+ * Filter a collection in parallel.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const op = Multithread.filter([1, 2, 3, 4], (value) => value % 2 === 0)
+ * // => operation that resolves to [2, 4]
+ * ```
+ *
+ * @category Filtering
+ */
+declare const filter: MultithreadFilter;
+/**
+ * Flat-map a collection in parallel.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const op = Multithread.flatMap([1, 2], (value) => [value, value * 10])
+ * // => operation that resolves to [1, 10, 2, 20]
+ * ```
+ *
+ * @category Sequencing
+ */
+declare const flatMap: MultithreadFlatMap;
+/**
+ * Resolve with the first successfully completed operation.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const fast = Multithread.run(() => 1)
+ * const slow = Multithread.run(() => 2)
+ * const op = Multithread.race([fast, slow])
+ * // => operation that resolves with the first finished result
+ * ```
+ *
+ * @category Combining
+ */
+declare const race: MultithreadRace;
+/**
+ * Return the first successful operation, aggregating failures if none succeed.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * import { Result } from "@nicolastoulemont/std"
+ *
+ * const fail = Multithread.run(() => Result.err("boom"))
+ * const pass = Multithread.run(() => Result.ok(1))
+ * const op = Multithread.firstSuccess([fail, pass])
+ * // => operation that resolves with 1
+ * ```
+ *
+ * @category Combining
+ */
+declare const firstSuccess: MultithreadFirstSuccess;
+/**
+ * Configure max worker count used by the underlying runtime.
+ *
+ * Must be called before first multithread operation starts.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const configured = Multithread.configure({ maxWorkers: 4 })
+ * // => { _tag: "Ok", value: undefined }
+ * ```
+ *
+ * @category Constructors
+ */
+declare const configure: (config: {
+  maxWorkers: number;
+}) => Result<void, MultithreadError>;
+/**
+ * Shutdown worker runtime.
+ *
+ * This function is idempotent.
+ *
+ * @example
+ * ```ts
+ * import { Multithread } from "@nicolastoulemont/std"
+ *
+ * const shutdownPromise = Multithread.shutdown()
+ * // => Promise<Result<void, MultithreadError>>
+ * ```
+ *
+ * @category Utilities
+ */
+declare const shutdown: () => Promise<Result<void, MultithreadError>>;
+//#endregion
+export { multithread_d_exports as t };
+//# sourceMappingURL=index-By6dNRc4.d.mts.map

package/dist/index-By6dNRc4.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-By6dNRc4.d.mts","names":[],"sources":["../src/multithread/multithread.types.ts","../src/multithread/multithread.ts"],"sourcesContent":[],"mappings":";;;;;;;;AASA;AAKA;AAMA;AAMY,KAjBA,iBAAA,GAAoB,UAiBpB,CAjB+B,iBAiBU,CAAA,GAAA,IAAA;AAKrD;AAMA;AAKA;AASY,KArCA,cAAA,GAqCgB;EACxB,SAAA,MAAA,EArCe,iBAqCf;EACA,WAAA,EAAA,EAAA,OAAA;EACA,gBAAA,EAAA,EAAA,IAAA;CACA;AACA,KApCQ,kCAAA,GAoCR;EAAyB,SAAA,IAAA,EAAA,oCAAA;EASjB,SAAA,OAAY,EAAA,MAAA;EAAS,SAAA,KAAA,CAAA,EAAA,OAAA;CAAe;AAAG,KAvCvC,yCAAA,GAuCuC;EAAd,SAAA,IAAA,EAAA,2CAAA;EAA2B,SAAA,OAAA,EAAA,MAAA;CAAR;AAAgC,KAlC5E,+BAAA,GAkC4E;EAAG,SAAA,IAAA,EAAA,iCAAA;EAAd,SAAA,OAAA,EAAA,MAAA;EAAR,SAAA,KAAA,EAAA,OAAA;CAAO;AAShE,KArCA,yBAAA,GAqCa;EAAY,SAAA,IAAA,EAAA,2BAAA;EAAG,SAAA,OAAA,EAAA,MAAA;CAAN;AAEH,KAlCnB,yBAAA,GAkCmB;EAAG,SAAA,IAAA,EAAA,2BAAA;EAAd,SAAA,OAAA,EAAA,MAAA;EAAR,SAAA,MAAA,EAAA,SAAA,OAAA,EAAA;CAEmB;;;;AACY,KA5B/B,gBAAA,GACR,kCA2BuC,GA1BvC,yCA0BuC,GAzBvC,+BAyBuC,GAxBvC,yBAwBuC,GAvBvC,yBAuBuC;;;;AAG3C;AAEC;;;AAEgH,KArBrG,YAqBqG,CAAA,CAAA,EAAA,CAAA,CAAA,GArBhF,CAqBgF,GArB5E,MAqB4E,CArBjE,CAqBiE,EArB9D,CAqB8D,CAAA,GArBzD,OAqByD,CArBjD,CAqBiD,CAAA,GArB5C,OAqB4C,CArBpC,MAqBoC,CArBzB,CAqByB,EArBtB,CAqBsB,CAAA,CAAA;;;;AAEjH;;;;AACkD,KAftC,aAesC,CAAA,CAAA,EAAA,CAAA,CAAA,GAfhB,EAegB,CAfb,CAea,EAfV,CAeU,CAAA,GAAA;EAAmC,SAAA,IAAA,EAAA,eAAA;EAAG,MAAA,EAAA,EAb5E,OAa4E,CAbpE,MAaoE,CAbzD,CAayD,EAbtD,CAasD,CAAA,CAAA;EAAI,KAAA,EAAA,EAAA,IAAA;EAArB,IAAA,EAX/D,WAW+D,CAXnD,MAWmD,CAXxC,CAWwC,EAXrC,CAWqC,CAAA,CAAA,CAAA,MAAA,CAAA;EAE7C,CAAA,MAAA,CAAA,aAAA,GAAA,EAZE,cAYF,CAZiB,CAYjB,EAZoB,CAYpB,EAAA,OAAA,CAAA;CAAM;AAAG,KATvB,0BAAA,GASuB;EAAvB,SAAA,WAAA,CAAA,EAAA,MAAA;CACC;KANR,aAOc,CAAA,aAAA,SAAA,OAAA,EAAA,EAAA,CAAA,EAAA,CAAA,CAAA,GAAA,CAAA,GAAA,IAAA,EAAA,CAAA,GAPuD,IAOvD,EAP6D,cAO7D,CAAA,EAAA,GAPiF,YAOjF,CAP8F,CAO9F,EAPiG,CAOjG,CAAA;AAAG,KALV,cAAA,GAKU;EAAI,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,CAAA,GAAA,EAJK,cAIL,EAAA,GAJwB,YAIxB,CAJqC,CAIrC,EAJwC,CAIxC,CAAA,CAAA,EAJ6C,aAI7C,CAJ2D,CAI3D,EAJ8D,CAI9D,GAJkE,gBAIlE,CAAA;EAArB,CAAA,aAAA,SAAA,OAAA,EAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAFO,aAEP,CAFqB,IAErB,EAF2B,CAE3B,EAF8B,CAE9B,CAAA,EAAA,GAAA,IAAA,EADQ,IACR,CAAA,EAAA,aAAA,CAAc,CAAd,EAAiB,CAAjB,GAAqB,gBAArB,CAAA;CAAa;AAGN,KAAA,eAAA,GAAe;EACI,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,CAAA,GAAA,EAAA,cAAA,EAAA,GAAmB,YAAnB,CAAgC,CAAhC,EAAmC,CAAnC,CAAA,CAAA,EAAA,GAAA,GAA8C,aAA9C,CAA4D,CAA5D,EAA+D,CAA/D,GAAmE,gBAAnE,CAAA;EAAgC,CAAA,aAAA,SAAA,OAAA,EAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAEnD,aAFmD,CAErC,IAFqC,EAE/B,CAF+B,EAE5B,CAF4B,CAAA,CAAA,EAAA,CAAA,GAAA,IAAA,EAGhD,IAHgD,EAAA,GAGvC,aAHuC,CAGzB,CAHyB,EAGtB,CAHsB,GAGlB,gBAHkB,CAAA;CAAG;AAAhB,KAMtC,oBANsC,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,GAAA,CAAA,KAAA,EAME,CANF,EAAA,KAAA,EAAA,MAAA,EAAA,GAAA,EAMyB,cANzB,EAAA,GAM4C,YAN5C,CAMyD,CANzD,EAM4D,CAN5D,CAAA;AAAyC,KAQ/E,cAAA,GAR+E;EAAG,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,SAUzE,CAVyE,EAAA,EAAA,MAAA,EAWlF,oBAXkF,CAW7D,CAX6D,EAW1D,CAX0D,EAWvD,CAXuD,CAAA,EAAA,OAAA,CAAA,EAYhF,0BAZgF,CAAA,EAazF,aAbyF,CAAA,SAalE,CAbkE,EAAA,EAa7D,CAb6D,GAazD,gBAbyD,CAAA;EAAI,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,EAAA,SAAA,KAAA,CAAA,CAAA,MAAA,EAetF,MAfsF,CAAA,SAelE,CAfkE,EAAA,EAe7D,MAf6D,CAAA,EAAA,MAAA,EAgBtF,oBAhBsF,CAgBjE,CAhBiE,EAgB9D,CAhB8D,EAgB3D,CAhB2D,CAAA,EAAA,OAAA,CAAA,EAiBpF,0BAjBoF,CAAA,EAkB7F,OAlB6F,CAkBrF,MAlBqF,CAAA,SAkBjE,CAlBiE,EAAA,EAkB5D,CAlB4D,GAkBxD,MAlBwD,GAkB/C,gBAlB+C,CAAA,CAAA;EAArB,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAoBjE,oBApBiE,CAoB5C,CApB4C,EAoBzC,CApByC,EAoBtC,CApBsC,CAAA,EAAA,OAAA,CAAA,EAqB/D,0BArB+D,CAAA,EAAA,CAAA,cAAA,SAsBhD,CAtBgD,EAAA,GAsB1C,MAtB0C,CAAA,SAsBtB,CAtBsB,EAAA,EAAA,OAAA,CAAA,CAAA,CAAA,MAAA,EAuBjE,KAvBiE,EAAA,GAwBtE,KAxBsE,SAwBxD,MAxBwD,CAAA,SAwBpC,CAxBoC,EAAA,EAAA,KAAA,OAAA,CAAA,GAyBvE,OAzBuE,CAyB/D,MAzB+D,CAAA,SAyB3C,CAzB2C,EAAA,EAyBtC,CAzBsC,GAyBlC,MAzBkC,GAyBzB,gBAzByB,CAAA,CAAA,GA0BvE,aA1BuE,CAAA,SA0BhD,CA1BgD,EAAA,EA0B3C,CA1B2C,GA0BvC,gBA1BuC,CAAA;CAEnD;AAAM,KA2BpB,kBAAA,GA3BoB;EAAG,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,SA6Bd,CA7Bc,EAAA,EAAA,MAAA,EA8BvB,oBA9BuB,CA8BF,CA9BE,EAAA,OAAA,EA8BU,CA9BV,CAAA,EAAA,OAAA,CAAA,EA+BrB,0BA/BqB,CAAA,EAgC9B,aAhC8B,CAAA,IAAA,EAgCV,CAhCU,GAgCN,gBAhCM,CAAA;EAAvB,CAAA,CAAA,EAAA,IAAA,KAAA,EAAA,SAAA,KAAA,CAAA,CAAA,MAAA,EAkCA,MAlCA,CAAA,SAkCoB,CAlCpB,EAAA,EAkCyB,MAlCzB,CAAA,EAAA,MAAA,EAmCA,oBAnCA,CAmCqB,CAnCrB,EAAA,OAAA,EAmCiC,CAnCjC,CAAA,EAAA,OAAA,CAAA,EAoCE,0BApCF,CAAA,EAqCP,OArCO,CAqCC,MArCD,CAAA,IAAA,EAqCkB,CArClB,GAqCsB,MArCtB,GAqC+B,gBArC/B,CAAA,CAAA;EACG,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAsCH,oBAtCG,CAsCkB,CAtClB,EAAA,OAAA,EAsC8B,CAtC9B,CAAA,EAAA,OAAA,CAAA,EAuCD,0BAvCC,CAAA,EAAA,CAAA,cAAA,SAwCc,CAxCd,EAAA,GAwCoB,MAxCpB,CAAA,SAwCwC,CAxCxC,EAAA,EAAA,OAAA,CAAA,CAAA,CAAA,MAAA,EAyCH,KAzCG,EAAA,GA0CR,KA1CQ,SA0CM,MA1CN,CAAA,SA0C0B,CA1C1B,EAAA,EAAA,KAAA,OAAA,CAAA,GA2CT,OA3CS,CA2CD,MA3CC,CAAA,IAAA,EA2CgB,CA3ChB,GA2CoB,MA3CpB,GA2C6B,gBA3C7B,CAAA,CAAA,GA4CT,aA5CS,CAAA,IAAA,EA4CW,CA5CX,GA4Ce,gBA5Cf,CAAA;CAAuB;AAAG,KA+C7B,uBA/C6B,CAAA,CAAA,EAAA,CAAA,CAAA,GAAA,CAAA,KAAA,EA+CW,CA/CX,EAAA,KAAA,EAAA,MAAA,EAAA,GAAA,EA+CkC,cA/ClC,EAAA,GA+CqD,YA/CrD,CAAA,OAAA,EA+C2E,CA/C3E,CAAA;AAAI,KAiDjC,iBAAA,GAjDiC;EAArB,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,SAmDH,CAnDG,EAAA,EAAA,MAAA,EAoDZ,uBApDY,CAoDY,CApDZ,EAoDe,CApDf,CAAA,EAAA,OAAA,CAAA,EAqDV,0BArDU,CAAA,EAsDnB,aAtDmB,CAAA,SAsDI,CAtDJ,EAAA,EAsDS,CAtDT,GAsDa,gBAtDb,CAAA;EAAa,CAAA,CAAA,EAAA,IAAA,KAAA,EAAA,SAAA,KAAA,CAAA,CAAA,MAAA,EAwDzB,MAxDyB,CAAA,SAwDL,CAxDK,EAAA,EAwDA,MAxDA,CAAA,EAAA,MAAA,EAyDzB,uBAzDyB,CAyDD,CAzDC,EAyDE,CAzDF,CAAA,EAAA,OAAA,CAAA,EA0DvB,0BA1DuB,CAAA,EA2DhC,OA3DgC,CA2DxB,MA3DwB,CAAA,SA2DJ,CA3DI,EAAA,EA2DC,CA3DD,GA2DK,MA3DL,GA2Dc,gBA3Dd,CAAA,CAAA;EAGzB,CAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EA0DA,uBA1DoB,CA0DI,CA1DJ,EA0DO,CA1DP,CAAA,EAAA,OAAA,CAAA,EA2DlB,0BA3DkB,CAAA,EAAA,CAAA,cAAA,SA4DH,CA5DG,EAAA,GA4DG,MA5DH,CAAA,SA4DuB,CA5DvB,EAAA,EAAA,OAAA,CAAA,CAAA,CAAA,MAAA,EA6DpB,KA7DoB,EAAA,GA8DzB,KA9DyB,SA8DX,MA9DW,CAAA,SA8DS,CA9DT,EAAA,EAAA,KAAA,OAAA,CAAA,GA+D1B,OA/D0B,CA+DlB,MA/DkB,CAAA,SA+DE,CA/DF,EAAA,EA+DO,CA/DP,GA+DW,MA/DX,GA+DoB,gBA/DpB,CAAA,CAAA,GAgE1B,aAhE0B,CAAA,SAgEH,CAhEG,EAAA,EAgEE,CAhEF,GAgEM,gBAhEN,CAAA;CAAoB;AAAuB,KAmE/D,wBAnE+D,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,GAAA,CAAA,KAAA,EAoElE,CApEkE,EAAA,KAAA,EAAA,MAAA,EAAA,GAAA,EAsEpE,cAtEoE,EAAA,GAuEtE,YAvEsE,CAAA,SAuEhD,CAvEgD,EAAA,GAuE1C,CAvE0C,EAAA,EAuErC,CAvEqC,CAAA;AAAgC,KAyE/F,kBAAA,GAzE+F;EAAG,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAAA,SA2EzF,CA3EyF,EAAA,EAAA,MAAA,EA4ElG,wBA5EkG,CA4EzE,CA5EyE,EA4EtE,CA5EsE,EA4EnE,CA5EmE,CAAA,EAAA,OAAA,CAAA,EA6EhG,0BA7EgG,CAAA,EA8EzG,aA9EyG,CAAA,SA8ElF,CA9EkF,EAAA,EA8E7E,CA9E6E,GA8EzE,gBA9EyE,CAAA;EAAhB,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,EAAA,SAAA,KAAA,CAAA,CAAA,MAAA,EAgFlF,MAhFkF,CAAA,SAgF9D,CAhF8D,EAAA,EAgFzD,MAhFyD,CAAA,EAAA,MAAA,EAiFlF,wBAjFkF,CAiFzD,CAjFyD,EAiFtD,CAjFsD,EAiFnD,CAjFmD,CAAA,EAAA,OAAA,CAAA,EAkFhF,0BAlFgF,CAAA,EAmFzF,OAnFyF,CAmFjF,MAnFiF,CAAA,SAmF7D,CAnF6D,EAAA,EAmFxD,CAnFwD,GAmFpD,MAnFoD,GAmF3C,gBAnF2C,CAAA,CAAA;EAAY,CAAA,CAAA,EAAA,CAAA,EAAA,IAAA,KAAA,CAAA,CAAA,MAAA,EAqF9F,wBArF8F,CAqFrE,CArFqE,EAqFlE,CArFkE,EAqF/D,CArF+D,CAAA,EAAA,OAAA,CAAA,EAsF5F,0BAtF4F,CAAA,EAAA,CAAA,cAAA,SAuF7E,CAvF6E,EAAA,GAuFvE,MAvFuE,CAAA,SAuFnD,CAvFmD,EAAA,EAAA,OAAA,CAAA,CAAA,CAAA,MAAA,EAwF9F,KAxF8F,EAAA,GAyFnG,KAzFmG,SAyFrF,MAzFqF,CAAA,SAyFjE,CAzFiE,EAAA,EAAA,KAAA,OAAA,CAAA,GA0FpG,OA1FoG,CA0F5F,MA1F4F,CAAA,SA0FxE,CA1FwE,EAAA,EA0FnE,CA1FmE,GA0F/D,MA1F+D,GA0FtD,gBA1FsD,CAAA,CAAA,GA2FpG,aA3FoG,CAAA,SA2F7E,CA3F6E,EAAA,EA2FxE,CA3FwE,GA2FpE,gBA3FoE,CAAA;AAE1G,CAAA;KA4FK,gBA1FgB,CAAA,CAAA,CAAA,GA0FM,CA1FN,SA0FgB,aA1FhB,CAAA,KAAA,EAAA,EAAA,OAAA,CAAA,GAAA,CAAA,GAAA,KAAA;KA2FhB,kBA1F4B,CAAA,CAAA,CAAA,GA0FJ,CA1FI,SA0FM,aA1FN,CAAA,OAAA,EAAA,KAAA,EAAA,CAAA,GAAA,CAAA,GAAA,KAAA;AAAG,KA4FxB,eAAA,GA5FwB;EAAG,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,UAAA,EAAA,SA6FT,aA7FS,CA6FK,CA7FL,EA6FQ,CA7FR,CAAA,EAAA,CAAA,EA6Fe,aA7Ff,CA6F6B,CA7F7B,EA6FgC,CA7FhC,GA6FoC,gBA7FpC,CAAA;EAA3B,CAAA,CAAA,EAAA,CAAA,EAAA,SAAA,KAAA,CAAA,CAAA,UAAA,EA+FI,MA/FJ,CAAA,SA+FwB,aA/FxB,CA+FsC,CA/FtC,EA+FyC,CA/FzC,CAAA,EAAA,EA+F+C,MA/F/C,CAAA,CAAA,EAgGP,OAhGO,CAgGC,MAhGD,CAgGY,CAhGZ,EAgGe,CAhGf,GAgGmB,MAhGnB,GAgG4B,gBAhG5B,CAAA,CAAA;EACE,CAAA,YAAA,SAgGU,aAhGV,CAAA,OAAA,EAAA,OAAA,CAAA,EAAA,CAAA,CAAA,UAAA,EAiGE,GAjGF,CAAA,EAkGT,aAlGS,CAkGK,gBAlGL,CAkGsB,GAlGtB,CAAA,MAAA,CAAA,CAAA,EAkGoC,kBAlGpC,CAkGuD,GAlGvD,CAAA,MAAA,CAAA,CAAA,GAkGsE,gBAlGtE,CAAA;EACc,CAAA,YAAA,SAkGJ,aAlGI,CAAA,OAAA,EAAA,OAAA,CAAA,EAAA,EAAA,SAAA,KAAA,CAAA,CAAA,UAAA,EAmGZ,MAnGY,CAmGD,GAnGC,EAmGI,MAnGJ,CAAA,CAAA,EAoGvB,OApGuB,CAoGf,MApGe,CAoGJ,gBApGI,CAoGa,GApGb,CAAA,MAAA,CAAA,CAAA,EAoG2B,kBApG3B,CAoG8C,GApG9C,CAAA,MAAA,CAAA,CAAA,GAoG6D,MApG7D,GAoGsE,gBApGtE,CAAA,CAAA;CAAK;AAAI,KAuGzB,uBAAA,GAvGyB;EAAhC,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,UAAA,EAAA,SAwGyB,aAxGzB,CAwGuC,CAxGvC,EAwG0C,CAxG1C,CAAA,EAAA,CAAA,EAwGiD,aAxGjD,CAwG+D,CAxG/D,EAwGkE,CAxGlE,GAwGsE,gBAxGtE,CAAA;EAE2B,CAAA,CAAA,EAAA,CAAA,EAAA,SAAA,KAAA,CAAA,CAAA,UAAA,EAwGhB,MAxGgB,CAAA,SAwGI,aAxGJ,CAwGkB,CAxGlB,EAwGqB,CAxGrB,CAAA,EAAA,EAwG2B,MAxG3B,CAAA,CAAA,EAyG3B,OAzG2B,CAyGnB,MAzGmB,CAyGR,CAzGQ,EAyGL,CAzGK,GAyGD,MAzGC,GAyGQ,gBAzGR,CAAA,CAAA;EAAK,CAAA,YAAA,SA0Gb,aA1Ga,CAAA,OAAA,EAAA,OAAA,CAAA,EAAA,CAAA,CAAA,UAAA,EA2GrB,GA3GqB,CAAA,EA4GhC,aA5GgC,CA4GlB,gBA5GkB,CA4GD,GA5GC,CAAA,MAAA,CAAA,CAAA,EA4Ga,kBA5Gb,CA4GgC,GA5GhC,CAAA,MAAA,CAAA,CAAA,GA4G+C,gBA5G/C,CAAA;EAAzB,CAAA,YAAA,SA6GY,aA7GZ,CAAA,OAAA,EAAA,OAAA,CAAA,EAAA,EAAA,SAAA,KAAA,CAAA,CAAA,UAAA,EA8GI,MA9GJ,CA8Ge,GA9Gf,EA8GoB,MA9GpB,CAAA,CAAA,EA+GP,OA/GO,CA+GC,MA/GD,CA+GY,gBA/GZ,CA+G6B,GA/G7B,CAAA,MAAA,CAAA,CAAA,EA+G2C,kBA/G3C,CA+G8D,GA/G9D,CAAA,MAAA,CAAA,CAAA,GA+G6E,MA/G7E,GA+GsF,gBA/GtF,CAAA,CAAA;CACqB;AAAA;;;;;;AA/BjC;AAEC;;;;;;;AAID;;AAC+D,cCiclD,GDjckD,ECic7C,cDjc6C;;;;;;;;;;;;;;;AAI1D,cC0dQ,ID1dR,EC0dc,eD1dd;;AAGL;;;;;;;;;;;;AAGY,cCioBC,GDjoBD,ECioBM,cDjoBN;;;;;;;AAIZ;;;;;;;AAEY,cC8sBC,OD9sBa,EC8sBJ,kBD9sBI;;;;;;;;;;;;;;AAQO,cCmyBpB,MDnyBoB,ECmyBZ,iBDnyBY;;;;;;;;;;;;;;AAIrB,cC03BC,OD13BD,EC03BU,kBD13BV;;;;;;;;;;;;;;;;AAMsB,cC+8BrB,ID/8BqB,EC+8Bf,eD/8Be;;;;AAGlC;;;;;;;;;;;;;;AAQY,cCykCC,YDzkCD,ECykCe,uBDzkCf;;;;;;;;;;;;;;;;AAQ6B,cCklC5B,SDllC4B,EAAA,CAAA,MAAA,EAAA;EAApB,UAAA,EAAA,MAAA;CACU,EAAA,GCilC4B,MDjlC5B,CAAA,IAAA,ECilC6C,gBDjlC7C,CAAA;;;;;;;;;AAI/B;;;;;;AAEA;AAEqB,cComCR,QDpmCQ,EAAA,GAAA,GComCa,ODpmCb,CComCqB,MDpmCrB,CAAA,IAAA,EComCsC,gBDpmCtC,CAAA,CAAA"}

package/dist/index-CCo85AdC.d.mts

@@ -0,0 +1,121 @@
+import { t as TaggedErrorFactory } from "./data.tagged-error.types-CLlJJ3n5.mjs";
+import { i as QueueOptions, n as Queue, r as QueueBoundedOptions } from "./queue.types-CD2LOu37.mjs";
+
+//#region src/queue/queue.d.ts
+declare namespace queue_d_exports {
+  export { QueueAbortedError, QueueClosedError, QueueTaskAbortedError, bounded, is, make, unbounded };
+}
+declare const QueueClosedError_base: TaggedErrorFactory<"QueueClosedError">;
+/**
+ * Error raised when enqueueing into a non-open queue.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const error = new Queue.QueueClosedError({ state: "draining" })
+ * // => { _tag: "QueueClosedError", state: "draining" }
+ * ```
+ *
+ * @category Models
+ */
+declare class QueueClosedError extends QueueClosedError_base<{
+  state: "draining" | "aborted";
+}> {}
+declare const QueueAbortedError_base: TaggedErrorFactory<"QueueAbortedError">;
+/**
+ * Error raised when queue processing is aborted.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const error = new Queue.QueueAbortedError({ reason: "manual" })
+ * // => { _tag: "QueueAbortedError", reason: "manual" }
+ * ```
+ *
+ * @category Models
+ */
+declare class QueueAbortedError extends QueueAbortedError_base<{
+  reason?: unknown;
+}> {}
+declare const QueueTaskAbortedError_base: TaggedErrorFactory<"QueueTaskAbortedError">;
+/**
+ * Error raised when a specific task is aborted.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const error = new Queue.QueueTaskAbortedError({ reason: "signal" })
+ * // => { _tag: "QueueTaskAbortedError", reason: "signal" }
+ * ```
+ *
+ * @category Models
+ */
+declare class QueueTaskAbortedError extends QueueTaskAbortedError_base<{
+  reason?: unknown;
+}> {}
+/**
+ * Check if a value is a `Queue`.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const queue = Queue.make()
+ * const isQueue = Queue.is(queue)
+ * // => true
+ * ```
+ *
+ * @category Guards
+ */
+declare const is: (value: unknown) => value is Queue;
+/**
+ * Create a queue with default unbounded capacity.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const queue = Queue.make()
+ * const pending = queue.pending
+ * // => 0
+ * ```
+ *
+ * @category Constructors
+ */
+declare const make: (options?: QueueOptions) => Queue;
+/**
+ * Create a queue with bounded capacity.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const queue = Queue.bounded(2)
+ * const size = queue.size
+ * // => 0
+ * ```
+ *
+ * @category Constructors
+ */
+declare const bounded: (maxSize: number, options?: QueueBoundedOptions) => Queue;
+/**
+ * Create a queue with explicit unbounded capacity.
+ *
+ * @example
+ * ```ts
+ * import { Queue } from "@nicolastoulemont/std"
+ *
+ * const queue = Queue.unbounded()
+ * const paused = queue.isPaused
+ * // => false
+ * ```
+ *
+ * @category Constructors
+ */
+declare const unbounded: (options?: QueueOptions) => Queue;
+//#endregion
+export { queue_d_exports as t };
+//# sourceMappingURL=index-CCo85AdC.d.mts.map

package/dist/index-CCo85AdC.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-CCo85AdC.d.mts","names":[],"sources":["../src/queue/queue.ts"],"sourcesContent":[],"mappings":";;;;;;;cAsCsB,uBAAA;;;;;;;;;;;;;AAAA;AAgBT,cAAA,gBAAA,SAAyB,qBAAA,CAAA;EAA0E,KAAA,EAAA,UAAA,GAAA,SAAA;AAchH,CAAA,CAAA,CAAA;AAcA,cA5BgH,sBA4B7E,EA5B6E,kBA4BrE,CAAA,mBAAA,CAAA;AAsG3C;AAsWA;AAgBA;AAgBA;;;;;;;;;;cA1fa,iBAAA,SAA0B;;;cAA8D,4BAAA;;;;;;;;;;;;;;cAcxF,qBAAA,SAA8B;;;;;;;;;;;;;;;;;cAsG9B,iCAAgC;;;;;;;;;;;;;;;cAsWhC,iBAAkB,iBAAe;;;;;;;;;;;;;;;cAgBjC,qCAAsC,wBAAsB;;;;;;;;;;;;;;;cAgB5D,sBAAuB,iBAAe"}