factories

{/* @generated by scripts/sync-content.mjs; do not edit */}

@sandlada/result/factories — constructors that turn values, predicates, throws and Promises into Results.

Scope

Operates on: IResultOfT construction (sync) and Promise<IResultOfT> construction (eager).
Execution model: synchronous; fromPromise, fromSafePromise, tryCatchAsync, asyncOk and asyncErr return in-flight Promises.
Not here: transformations (operators, promise-result), Option constructors (option).

Export	Description	Source
`ok`	Success without a value (`IResult<never>`) or with `value` (`IResultOfT<T, never>`); the error channel starts as `never` so it widens at the use site.	ok.ts
`err`	Failure carrying `error`; the error type is inferred from the argument and the value channel starts as `never`.	err.ts
`fromPredicate`	`Ok(value)` when the predicate passes, otherwise `Err(error)`.	fromPredicate.ts
`fromThrowable`	Wraps a possibly-throwing function into a Result-returning one.	fromThrowable.ts
`tryCatch`	Runs a thunk and captures a synchronous throw as `Err`.	tryCatch.ts

Export	Description	Source
`asyncOk`	Pre-resolved success `Promise<IResultOfT<T, never>>`.	asyncOk.ts
`asyncErr`	Pre-resolved failure `Promise<IResultOfT<never, E>>`.	asyncErr.ts
`fromPromise`	Wraps a Promise; a rejection becomes `Err` instead of staying a rejection.	fromPromise.ts
`fromSafePromise`	Wraps a Promise that is known never to reject; `E` defaults to `Error`.	fromSafePromise.ts
`tryCatchAsync`	Runs an async thunk; throws and rejections become `Err`.	tryCatchAsync.ts

ok and err return the narrowest variant (IResultOfT<T, never> / IResultOfT<never, E>). Use the dual-parameter overloads ok<T, E>(value) / err<T, E>(error) to widen without a cast when the surrounding context already declares a wider channel.
Every capture helper turns throws and rejections into values; none of them rejects.
fromSafePromise normalizes a non-Error rejection value to new Error(String(e)) when no errorFn is supplied; pass errorFn to keep your own error type.
Throw policy: behavior-modes.md §4.1.

Generic TError, defaulting to unknown. Constructors never coerce a failure into Error: err keeps the caller’s error type, and ok leaves the error channel at never until it widens at the use site.