resultar 3.4.0 → 3.5.1

package/dist/index.d.ts

@@ -742,6 +742,44 @@ interface ResultAsyncAbortSignal {
   removeEventListener: (type: "abort", listener: () => void) => void;
 }
 /**
+* Context passed to `ResultAsync.fromCallback` subscriptions.
+*/
+interface ResultAsyncCallbackContext<T> {
+  /**
+  * Completes the operation with `Ok(value)`.
+  */
+  readonly resolve: (value: T) => void;
+  /**
+  * Completes the operation with a cause mapped by the subscription's `catch` function.
+  */
+  readonly reject: (cause: unknown) => void;
+  /**
+  * Cooperative cancellation signal for the subscription.
+  */
+  readonly signal: ResultAsyncAbortSignal;
+}
+/**
+* Synchronous cleanup returned by a `ResultAsync.fromCallback` subscription.
+*/
+type ResultAsyncCallbackCleanup = () => void;
+/**
+* Options for adapting a callback or subscription API into `ResultAsync`.
+*/
+interface ResultAsyncFromCallbackOptions<T, E> {
+  /**
+  * Maps callback failures and synchronous subscription throws into the typed error channel.
+  */
+  readonly catch: (cause: unknown) => E;
+  /**
+  * Optional external signal that cancels the subscription with `AbortError`.
+  */
+  readonly signal?: ResultAsyncAbortSignal;
+  /**
+  * Registers the callback source and optionally returns a synchronous unsubscribe function.
+  */
+  readonly subscribe: (context: ResultAsyncCallbackContext<T>) => ResultAsyncCallbackCleanup | void;
+}
+/**
 * Concurrency setting for async collection helpers.
 *
 * Use a number for bounded parallelism or `'unbounded'` when every task may start immediately.
@@ -1019,7 +1057,7 @@ declare class DisposableResultAsync<T, E> implements PromiseLike<Result<T, E>>,
 * but operating in an asynchronous context.
 *
 * The class includes methods for:
-* - Creating ResultAsync instances (okAsync, errAsync, fromPromise)
+* - Creating ResultAsync instances (okAsync, errAsync, fromPromise, fromCallback)
 * - Transforming values (map, mapErr)
 * - Chaining operations (andThen, orElse)
 * - Error handling (tapError)
@@ -1082,6 +1120,13 @@ declare class ResultAsync<T, E> extends Pipeable implements PromiseLike<Result<T
   */
   static fromPromise<T, E>(this: void, promise: PromiseLike<T>, errorFn: (e: unknown) => E): ResultAsync<T, E>;
   /**
+  * Adapts a callback or subscription API into a cancellable ResultAsync.
+  *
+  * The returned cleanup function runs once after resolve, reject, cancellation, or synchronous
+  * subscription failure. Cleanup errors are ignored.
+  */
+  static fromCallback<T, E>(this: void, options: ResultAsyncFromCallbackOptions<T, E>): ResultAsync<T, E | AbortError>;
+  /**
   * Combines many ResultAsync values and stops at the first Err.
   *
   * Arrays return an Ok array, records return an Ok record with the same keys, and iterables return
@@ -1354,6 +1399,10 @@ declare const okAsync: typeof ResultAsync.okAsync;
 */
 declare const errAsync: typeof ResultAsync.errAsync;
 /**
+* Adapts a callback or subscription API into a cancellable ResultAsync.
+*/
+declare const fromCallback: typeof ResultAsync.fromCallback;
+/**
 * Converts an existing promise into a ResultAsync and maps rejection into a typed Err.
 */
 declare const fromPromise: typeof ResultAsync.fromPromise;
@@ -1628,5 +1677,4 @@ declare const matchError: <ErrorType extends Error, ReturnType>(error: ErrorType
 */
 declare const matchErrorPartial: <ErrorType extends Error, ReturnType>(error: ErrorType, handlers: PartialMatchHandlers<ErrorType, ReturnType>, fallback: (error: ErrorType) => ReturnType) => ReturnType;
 //#endregion
-export { AbortError, DisposableResult, DisposableResultAsync, type ErrResult, type OkResult, type Redacted, Result, ResultAsync, type ResultAsyncAbortSignal, type ResultAsyncConcurrency, type ResultAsyncRaceHandle, type ResultAsyncRaceTask, type ResultAsyncResourceAcquire, type ResultAsyncResourceEffect, type ResultAsyncResourceRelease, type ResultAsyncResourceReleaseContext, type ResultAsyncResourceUse, type ResultAsyncRetryContext, type ResultAsyncRetryOptions, type ResultAsyncRetryOrElseOptions, type ResultAsyncRetryTask, type ResultAsyncTimeoutOptions, type ResultAsyncWithResourceOptions, type ResultOperations, type SafeTryAsyncOptions, type SafeTryOptions, type StrictResult, type StrictResultAsync, type TaggedEnum, type TaggedEnumFactory, type TaggedErrorClass, type TaggedErrorInstance, type TaggedErrorOptions, type TryResultAsyncOptions, type TryResultOptions, createTaggedError, tryResult as default, tryResult as try, tryResult, err, errAsync, findCause, fromPromise, fromSafePromise, fromThrowable, fromThrowableAsync, isAbortError, isError, isRedacted, matchError, matchErrorPartial, ok, okAsync, redact, revealRedacted, runPromise, runSync, safeTry, taggedEnum, tryResultAsync as tryAsync, tryResultAsync, tryCatch, tryCatchAsync, unit, unitAsync };
-//# sourceMappingURL=index.d.ts.map
+export { AbortError, DisposableResult, DisposableResultAsync, type ErrResult, type OkResult, type Redacted, Result, ResultAsync, type ResultAsyncAbortSignal, type ResultAsyncCallbackCleanup, type ResultAsyncCallbackContext, type ResultAsyncConcurrency, type ResultAsyncFromCallbackOptions, type ResultAsyncRaceHandle, type ResultAsyncRaceTask, type ResultAsyncResourceAcquire, type ResultAsyncResourceEffect, type ResultAsyncResourceRelease, type ResultAsyncResourceReleaseContext, type ResultAsyncResourceUse, type ResultAsyncRetryContext, type ResultAsyncRetryOptions, type ResultAsyncRetryOrElseOptions, type ResultAsyncRetryTask, type ResultAsyncTimeoutOptions, type ResultAsyncWithResourceOptions, type ResultOperations, type SafeTryAsyncOptions, type SafeTryOptions, type StrictResult, type StrictResultAsync, type TaggedEnum, type TaggedEnumFactory, type TaggedErrorClass, type TaggedErrorInstance, type TaggedErrorOptions, type TryResultAsyncOptions, type TryResultOptions, createTaggedError, tryResult as default, tryResult as try, tryResult, err, errAsync, findCause, fromCallback, fromPromise, fromSafePromise, fromThrowable, fromThrowableAsync, isAbortError, isError, isRedacted, matchError, matchErrorPartial, ok, okAsync, redact, revealRedacted, runPromise, runSync, safeTry, taggedEnum, tryResultAsync as tryAsync, tryResultAsync, tryCatch, tryCatchAsync, unit, unitAsync };