effect
Version:
The missing standard library for TypeScript, for writing production-grade software.
1,459 lines • 88.4 kB
TypeScript
/**
* @since 2.0.0
*/
import * as Cause from "./Cause.js";
import type * as Context from "./Context.js";
import type * as Effect from "./Effect.js";
import type * as Either from "./Either.js";
import type * as FiberId from "./FiberId.js";
import type { LazyArg } from "./Function.js";
import type { TypeLambda } from "./HKT.js";
import type * as Option from "./Option.js";
import type { Pipeable } from "./Pipeable.js";
import type { Predicate, Refinement } from "./Predicate.js";
import type { Covariant, MergeRecord, NoExcessProperties, NoInfer } from "./Types.js";
import type * as Unify from "./Unify.js";
import type { YieldWrap } from "./Utils.js";
/**
* @since 2.0.0
* @category symbols
*/
export declare const STMTypeId: unique symbol;
/**
* @since 2.0.0
* @category symbols
*/
export type STMTypeId = typeof STMTypeId;
/**
* `STM<A, E, R>` represents an effect that can be performed transactionally,
* resulting in a failure `E` or a value `A` that may require an environment
* `R` to execute.
*
* Software Transactional Memory is a technique which allows composition of
* arbitrary atomic operations. It is the software analog of transactions in
* database systems.
*
* The API is lifted directly from the Haskell package Control.Concurrent.STM
* although the implementation does not resemble the Haskell one at all.
*
* See http://hackage.haskell.org/package/stm-2.5.0.0/docs/Control-Concurrent-STM.html
*
* STM in Haskell was introduced in:
*
* Composable memory transactions, by Tim Harris, Simon Marlow, Simon Peyton
* Jones, and Maurice Herlihy, in ACM Conference on Principles and Practice of
* Parallel Programming 2005.
*
* See https://www.microsoft.com/en-us/research/publication/composable-memory-transactions/
*
* See also:
* Lock Free Data Structures using STMs in Haskell, by Anthony Discolo, Tim
* Harris, Simon Marlow, Simon Peyton Jones, Satnam Singh) FLOPS 2006: Eighth
* International Symposium on Functional and Logic Programming, Fuji Susono,
* JAPAN, April 2006
*
* https://www.microsoft.com/en-us/research/publication/lock-free-data-structures-using-stms-in-haskell/
*
* The implemtation is based on the ZIO STM module, while JS environments have
* no race conditions from multiple threads STM provides greater benefits for
* synchronization of Fibers and transactional data-types can be quite useful.
*
* @since 2.0.0
* @category models
*/
export interface STM<out A, out E = never, out R = never> extends Effect.Effect<A, E, R>, STM.Variance<A, E, R>, Pipeable {
[Unify.typeSymbol]?: unknown;
[Unify.unifySymbol]?: STMUnify<this>;
[Unify.ignoreSymbol]?: STMUnifyIgnore;
[Symbol.iterator](): Effect.EffectGenerator<STM<A, E, R>>;
}
/**
* @since 2.0.0
* @category models
*/
export interface STMUnify<A extends {
[Unify.typeSymbol]?: any;
}> extends Effect.EffectUnify<A> {
STM?: () => A[Unify.typeSymbol] extends STM<infer A0, infer E0, infer R0> | infer _ ? STM<A0, E0, R0> : never;
}
/**
* @category models
* @since 2.0.0
*/
export interface STMUnifyIgnore extends Effect.EffectUnifyIgnore {
Effect?: true;
}
/**
* @category type lambdas
* @since 2.0.0
*/
export interface STMTypeLambda extends TypeLambda {
readonly type: STM<this["Target"], this["Out1"], this["Out2"]>;
}
/**
* @since 2.0.0
* @category models
*/
declare module "./Context.js" {
interface Tag<Id, Value> extends STM<Value, never, Id> {
}
interface Reference<Id, Value> extends STM<Value> {
}
}
/**
* @since 2.0.0
* @category models
*/
declare module "./Either.js" {
interface Left<E, A> extends STM<A, E> {
readonly _tag: "Left";
}
interface Right<E, A> extends STM<A, E> {
readonly _tag: "Right";
}
}
/**
* @since 2.0.0
* @category models
*/
declare module "./Option.js" {
interface None<A> extends STM<A, Cause.NoSuchElementException> {
readonly _tag: "None";
}
interface Some<A> extends STM<A, Cause.NoSuchElementException> {
readonly _tag: "Some";
}
}
/**
* @since 2.0.0
*/
export declare namespace STM {
/**
* @since 2.0.0
* @category models
*/
interface Variance<out A, out E, out R> {
readonly [STMTypeId]: {
readonly _A: Covariant<A>;
readonly _E: Covariant<E>;
readonly _R: Covariant<R>;
};
}
}
/**
* Returns `true` if the provided value is an `STM`, `false` otherwise.
*
* @since 2.0.0
* @category refinements
*/
export declare const isSTM: (u: unknown) => u is STM<unknown, unknown, unknown>;
/**
* Treats the specified `acquire` transaction as the acquisition of a
* resource. The `acquire` transaction will be executed interruptibly. If it
* is a success and is committed the specified `release` workflow will be
* executed uninterruptibly as soon as the `use` workflow completes execution.
*
* @since 2.0.0
* @category constructors
*/
export declare const acquireUseRelease: {
/**
* Treats the specified `acquire` transaction as the acquisition of a
* resource. The `acquire` transaction will be executed interruptibly. If it
* is a success and is committed the specified `release` workflow will be
* executed uninterruptibly as soon as the `use` workflow completes execution.
*
* @since 2.0.0
* @category constructors
*/
<A, A2, E2, R2, A3, E3, R3>(use: (resource: A) => STM<A2, E2, R2>, release: (resource: A) => STM<A3, E3, R3>): <E, R>(acquire: STM<A, E, R>) => Effect.Effect<A2, E2 | E3 | E, R2 | R3 | R>;
/**
* Treats the specified `acquire` transaction as the acquisition of a
* resource. The `acquire` transaction will be executed interruptibly. If it
* is a success and is committed the specified `release` workflow will be
* executed uninterruptibly as soon as the `use` workflow completes execution.
*
* @since 2.0.0
* @category constructors
*/
<A, E, R, A2, E2, R2, A3, E3, R3>(acquire: STM<A, E, R>, use: (resource: A) => STM<A2, E2, R2>, release: (resource: A) => STM<A3, E3, R3>): Effect.Effect<A2, E | E2 | E3, R | R2 | R3>;
};
/**
* @since 2.0.0
* @category utils
*/
export declare namespace All {
type STMAny = STM<any, any, any>;
type ReturnTuple<T extends ReadonlyArray<STM<any, any, any>>, Discard extends boolean> = STM<Discard extends true ? void : T[number] extends never ? [] : {
-readonly [K in keyof T]: [T[K]] extends [STM<infer A, infer _E, infer _R>] ? A : never;
}, T[number] extends never ? never : [T[number]] extends [{
[STMTypeId]: {
_E: (_: never) => infer E;
};
}] ? E : never, T[number] extends never ? never : [T[number]] extends [{
[STMTypeId]: {
_R: (_: never) => infer R;
};
}] ? R : never> extends infer X ? X : never;
type ReturnIterable<T extends Iterable<STMAny>, Discard extends boolean> = [T] extends [
Iterable<STM.Variance<infer A, infer E, infer R>>
] ? STM<Discard extends true ? void : Array<A>, E, R> : never;
type ReturnObject<T extends Record<string, STMAny>, Discard extends boolean> = STM<Discard extends true ? void : {
-readonly [K in keyof T]: [T[K]] extends [STM.Variance<infer A, infer _E, infer _R>] ? A : never;
}, keyof T extends never ? never : [T[keyof T]] extends [{
[STMTypeId]: {
_E: (_: never) => infer E;
};
}] ? E : never, keyof T extends never ? never : [T[keyof T]] extends [{
[STMTypeId]: {
_R: (_: never) => infer R;
};
}] ? R : never>;
/**
* @since 2.0.0
* @category utils
*/
type Options = {
readonly discard?: boolean | undefined;
};
type IsDiscard<A> = [Extract<A, {
readonly discard: true;
}>] extends [never] ? false : true;
type Narrow<A> = (A extends [] ? [] : never) | A;
/**
* @since 2.0.0
* @category utils
*/
interface Signature {
<Arg extends ReadonlyArray<STMAny> | Iterable<STMAny> | Record<string, STMAny>, O extends NoExcessProperties<Options, O>>(arg: Narrow<Arg>, options?: O): [Arg] extends [ReadonlyArray<STMAny>] ? ReturnTuple<Arg, IsDiscard<O>> : [Arg] extends [Iterable<STMAny>] ? ReturnIterable<Arg, IsDiscard<O>> : [Arg] extends [Record<string, STMAny>] ? ReturnObject<Arg, IsDiscard<O>> : never;
}
}
/**
* Runs all the provided transactional effects in sequence respecting the
* structure provided in input.
*
* Supports multiple arguments, a single argument tuple / array or record /
* struct.
*
* @since 2.0.0
* @category constructors
*/
export declare const all: All.Signature;
/**
* Maps the success value of this effect to the specified constant value.
*
* @since 2.0.0
* @category mapping
*/
export declare const as: {
/**
* Maps the success value of this effect to the specified constant value.
*
* @since 2.0.0
* @category mapping
*/
<A2>(value: A2): <A, E, R>(self: STM<A, E, R>) => STM<A2, E, R>;
/**
* Maps the success value of this effect to the specified constant value.
*
* @since 2.0.0
* @category mapping
*/
<A, E, R, A2>(self: STM<A, E, R>, value: A2): STM<A2, E, R>;
};
/**
* Maps the success value of this effect to an optional value.
*
* @since 2.0.0
* @category mapping
*/
export declare const asSome: <A, E, R>(self: STM<A, E, R>) => STM<Option.Option<A>, E, R>;
/**
* Maps the error value of this effect to an optional value.
*
* @since 2.0.0
* @category mapping
*/
export declare const asSomeError: <A, E, R>(self: STM<A, E, R>) => STM<A, Option.Option<E>, R>;
/**
* This function maps the success value of an `STM` to `void`. If the original
* `STM` succeeds, the returned `STM` will also succeed. If the original `STM`
* fails, the returned `STM` will fail with the same error.
*
* @since 2.0.0
* @category mapping
*/
export declare const asVoid: <A, E, R>(self: STM<A, E, R>) => STM<void, E, R>;
/**
* Creates an `STM` value from a partial (but pure) function.
*
* @since 2.0.0
* @category constructors
*/
export declare const attempt: <A>(evaluate: LazyArg<A>) => STM<A, unknown>;
/**
* Recovers from all errors.
*
* @since 2.0.0
* @category error handling
*/
export declare const catchAll: {
/**
* Recovers from all errors.
*
* @since 2.0.0
* @category error handling
*/
<E, B, E1, R1>(f: (e: E) => STM<B, E1, R1>): <A, R>(self: STM<A, E, R>) => STM<B | A, E1, R1 | R>;
/**
* Recovers from all errors.
*
* @since 2.0.0
* @category error handling
*/
<A, E, R, B, E1, R1>(self: STM<A, E, R>, f: (e: E) => STM<B, E1, R1>): STM<A | B, E1, R | R1>;
};
/**
* Recovers from some or all of the error cases.
*
* @since 2.0.0
* @category error handling
*/
export declare const catchSome: {
/**
* Recovers from some or all of the error cases.
*
* @since 2.0.0
* @category error handling
*/
<E, A2, E2, R2>(pf: (error: E) => Option.Option<STM<A2, E2, R2>>): <A, R>(self: STM<A, E, R>) => STM<A2 | A, E | E2, R2 | R>;
/**
* Recovers from some or all of the error cases.
*
* @since 2.0.0
* @category error handling
*/
<A, E, R, A2, E2, R2>(self: STM<A, E, R>, pf: (error: E) => Option.Option<STM<A2, E2, R2>>): STM<A | A2, E | E2, R | R2>;
};
/**
* Recovers from the specified tagged error.
*
* @since 2.0.0
* @category error handling
*/
export declare const catchTag: {
/**
* Recovers from the specified tagged error.
*
* @since 2.0.0
* @category error handling
*/
<K extends E["_tag"] & string, E extends {
_tag: string;
}, A1, E1, R1>(k: K, f: (e: Extract<E, {
_tag: K;
}>) => STM<A1, E1, R1>): <A, R>(self: STM<A, E, R>) => STM<A1 | A, E1 | Exclude<E, {
_tag: K;
}>, R1 | R>;
/**
* Recovers from the specified tagged error.
*
* @since 2.0.0
* @category error handling
*/
<A, E extends {
_tag: string;
}, R, K extends E["_tag"] & string, A1, E1, R1>(self: STM<A, E, R>, k: K, f: (e: Extract<E, {
_tag: K;
}>) => STM<A1, E1, R1>): STM<A | A1, E1 | Exclude<E, {
_tag: K;
}>, R | R1>;
};
/**
* Recovers from multiple tagged errors.
*
* @since 2.0.0
* @category error handling
*/
export declare const catchTags: {
/**
* Recovers from multiple tagged errors.
*
* @since 2.0.0
* @category error handling
*/
<E extends {
_tag: string;
}, Cases extends {
[K in E["_tag"]]+?: ((error: Extract<E, {
_tag: K;
}>) => STM<any, any, any>);
}>(cases: Cases): <A, R>(self: STM<A, E, R>) => STM<A | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<infer A, any, any> ? A : never;
}[keyof Cases], Exclude<E, {
_tag: keyof Cases;
}> | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<any, infer E, any> ? E : never;
}[keyof Cases], R | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<any, any, infer R> ? R : never;
}[keyof Cases]>;
/**
* Recovers from multiple tagged errors.
*
* @since 2.0.0
* @category error handling
*/
<R, E extends {
_tag: string;
}, A, Cases extends {
[K in E["_tag"]]+?: ((error: Extract<E, {
_tag: K;
}>) => STM<any, any, any>);
}>(self: STM<A, E, R>, cases: Cases): STM<A | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<infer A, any, any> ? A : never;
}[keyof Cases], Exclude<E, {
_tag: keyof Cases;
}> | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<any, infer E, any> ? E : never;
}[keyof Cases], R | {
[K in keyof Cases]: Cases[K] extends (...args: Array<any>) => STM<any, any, infer R> ? R : never;
}[keyof Cases]>;
};
/**
* Checks the condition, and if it's true, returns unit, otherwise, retries.
*
* @since 2.0.0
* @category constructors
*/
export declare const check: (predicate: LazyArg<boolean>) => STM<void>;
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
export declare const collect: {
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
<A, A2>(pf: (a: A) => Option.Option<A2>): <E, R>(self: STM<A, E, R>) => STM<A2, E, R>;
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
<A, E, R, A2>(self: STM<A, E, R>, pf: (a: A) => Option.Option<A2>): STM<A2, E, R>;
};
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
export declare const collectSTM: {
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
<A, A2, E2, R2>(pf: (a: A) => Option.Option<STM<A2, E2, R2>>): <E, R>(self: STM<A, E, R>) => STM<A2, E2 | E, R2 | R>;
/**
* Simultaneously filters and maps the value produced by this effect.
*
* @since 2.0.0
* @category mutations
*/
<A, E, R, A2, E2, R2>(self: STM<A, E, R>, pf: (a: A) => Option.Option<STM<A2, E2, R2>>): STM<A2, E | E2, R | R2>;
};
/**
* Commits this transaction atomically.
*
* @since 2.0.0
* @category destructors
*/
export declare const commit: <A, E, R>(self: STM<A, E, R>) => Effect.Effect<A, E, R>;
/**
* Commits this transaction atomically, regardless of whether the transaction
* is a success or a failure.
*
* @since 2.0.0
* @category destructors
*/
export declare const commitEither: <A, E, R>(self: STM<A, E, R>) => Effect.Effect<A, E, R>;
/**
* Similar to Either.cond, evaluate the predicate, return the given A as
* success if predicate returns true, and the given E as error otherwise
*
* @since 2.0.0
* @category constructors
*/
export declare const cond: <A, E>(predicate: LazyArg<boolean>, error: LazyArg<E>, result: LazyArg<A>) => STM<A, E>;
/**
* Retrieves the environment inside an stm.
*
* @since 2.0.0
* @category constructors
*/
export declare const context: <R>() => STM<Context.Context<R>, never, R>;
/**
* Accesses the environment of the transaction to perform a transaction.
*
* @since 2.0.0
* @category constructors
*/
export declare const contextWith: <R0, R>(f: (environment: Context.Context<R0>) => R) => STM<R, never, R0>;
/**
* Accesses the environment of the transaction to perform a transaction.
*
* @since 2.0.0
* @category constructors
*/
export declare const contextWithSTM: <R0, A, E, R>(f: (environment: Context.Context<R0>) => STM<A, E, R>) => STM<A, E, R0 | R>;
/**
* Transforms the environment being provided to this effect with the specified
* function.
*
* @since 2.0.0
* @category context
*/
export declare const mapInputContext: {
/**
* Transforms the environment being provided to this effect with the specified
* function.
*
* @since 2.0.0
* @category context
*/
<R0, R>(f: (context: Context.Context<R0>) => Context.Context<R>): <A, E>(self: STM<A, E, R>) => STM<A, E, R0>;
/**
* Transforms the environment being provided to this effect with the specified
* function.
*
* @since 2.0.0
* @category context
*/
<A, E, R0, R>(self: STM<A, E, R>, f: (context: Context.Context<R0>) => Context.Context<R>): STM<A, E, R0>;
};
/**
* Fails the transactional effect with the specified defect.
*
* @since 2.0.0
* @category constructors
*/
export declare const die: (defect: unknown) => STM<never>;
/**
* Kills the fiber running the effect with a `Cause.RuntimeException` that
* contains the specified message.
*
* @since 2.0.0
* @category constructors
*/
export declare const dieMessage: (message: string) => STM<never>;
/**
* Fails the transactional effect with the specified lazily evaluated defect.
*
* @since 2.0.0
* @category constructors
*/
export declare const dieSync: (evaluate: LazyArg<unknown>) => STM<never>;
/**
* Converts the failure channel into an `Either`.
*
* @since 2.0.0
* @category mutations
*/
export declare const either: <A, E, R>(self: STM<A, E, R>) => STM<Either.Either<A, E>, never, R>;
/**
* Executes the specified finalization transaction whether or not this effect
* succeeds. Note that as with all STM transactions, if the full transaction
* fails, everything will be rolled back.
*
* @since 2.0.0
* @category finalization
*/
export declare const ensuring: {
/**
* Executes the specified finalization transaction whether or not this effect
* succeeds. Note that as with all STM transactions, if the full transaction
* fails, everything will be rolled back.
*
* @since 2.0.0
* @category finalization
*/
<R1, B>(finalizer: STM<B, never, R1>): <A, E, R>(self: STM<A, E, R>) => STM<A, E, R1 | R>;
/**
* Executes the specified finalization transaction whether or not this effect
* succeeds. Note that as with all STM transactions, if the full transaction
* fails, everything will be rolled back.
*
* @since 2.0.0
* @category finalization
*/
<A, E, R, R1, B>(self: STM<A, E, R>, finalizer: STM<B, never, R1>): STM<A, E, R | R1>;
};
/**
* Returns an effect that ignores errors and runs repeatedly until it
* eventually succeeds.
*
* @since 2.0.0
* @category mutations
*/
export declare const eventually: <A, E, R>(self: STM<A, E, R>) => STM<A, E, R>;
/**
* Determines whether all elements of the `Iterable<A>` satisfy the effectual
* predicate.
*
* @since 2.0.0
* @category constructors
*/
export declare const every: {
/**
* Determines whether all elements of the `Iterable<A>` satisfy the effectual
* predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(predicate: (a: NoInfer<A>) => STM<boolean, E, R>): (iterable: Iterable<A>) => STM<boolean, E, R>;
/**
* Determines whether all elements of the `Iterable<A>` satisfy the effectual
* predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(iterable: Iterable<A>, predicate: (a: A) => STM<boolean, E, R>): STM<boolean, E, R>;
};
/**
* Determines whether any element of the `Iterable[A]` satisfies the effectual
* predicate `f`.
*
* @since 2.0.0
* @category constructors
*/
export declare const exists: {
/**
* Determines whether any element of the `Iterable[A]` satisfies the effectual
* predicate `f`.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(predicate: (a: NoInfer<A>) => STM<boolean, E, R>): (iterable: Iterable<A>) => STM<boolean, E, R>;
/**
* Determines whether any element of the `Iterable[A]` satisfies the effectual
* predicate `f`.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(iterable: Iterable<A>, predicate: (a: A) => STM<boolean, E, R>): STM<boolean, E, R>;
};
/**
* Fails the transactional effect with the specified error.
*
* @since 2.0.0
* @category constructors
*/
export declare const fail: <E>(error: E) => STM<never, E>;
/**
* Fails the transactional effect with the specified lazily evaluated error.
*
* @since 2.0.0
* @category constructors
*/
export declare const failSync: <E>(evaluate: LazyArg<E>) => STM<never, E>;
/**
* Returns the fiber id of the fiber committing the transaction.
*
* @since 2.0.0
* @category constructors
*/
export declare const fiberId: STM<FiberId.FiberId>;
/**
* Filters the collection using the specified effectual predicate.
*
* @since 2.0.0
* @category constructors
*/
export declare const filter: {
/**
* Filters the collection using the specified effectual predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(predicate: (a: NoInfer<A>) => STM<boolean, E, R>): (iterable: Iterable<A>) => STM<Array<A>, E, R>;
/**
* Filters the collection using the specified effectual predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(iterable: Iterable<A>, predicate: (a: A) => STM<boolean, E, R>): STM<Array<A>, E, R>;
};
/**
* Filters the collection using the specified effectual predicate, removing
* all elements that satisfy the predicate.
*
* @since 2.0.0
* @category constructors
*/
export declare const filterNot: {
/**
* Filters the collection using the specified effectual predicate, removing
* all elements that satisfy the predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(predicate: (a: NoInfer<A>) => STM<boolean, E, R>): (iterable: Iterable<A>) => STM<Array<A>, E, R>;
/**
* Filters the collection using the specified effectual predicate, removing
* all elements that satisfy the predicate.
*
* @since 2.0.0
* @category constructors
*/
<A, R, E>(iterable: Iterable<A>, predicate: (a: A) => STM<boolean, E, R>): STM<Array<A>, E, R>;
};
/**
* Dies with specified defect if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
export declare const filterOrDie: {
/**
* Dies with specified defect if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, B extends A>(refinement: Refinement<NoInfer<A>, B>, defect: LazyArg<unknown>): <E, R>(self: STM<A, E, R>) => STM<B, E, R>;
/**
* Dies with specified defect if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A>(predicate: Predicate<NoInfer<A>>, defect: LazyArg<unknown>): <E, R>(self: STM<A, E, R>) => STM<A, E, R>;
/**
* Dies with specified defect if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, B extends A>(self: STM<A, E, R>, refinement: Refinement<A, B>, defect: LazyArg<unknown>): STM<B, E, R>;
/**
* Dies with specified defect if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R>(self: STM<A, E, R>, predicate: Predicate<A>, defect: LazyArg<unknown>): STM<A, E, R>;
};
/**
* Dies with a `Cause.RuntimeException` having the specified message if the
* predicate fails.
*
* @since 2.0.0
* @category filtering
*/
export declare const filterOrDieMessage: {
/**
* Dies with a `Cause.RuntimeException` having the specified message if the
* predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, B extends A>(refinement: Refinement<NoInfer<A>, B>, message: string): <E, R>(self: STM<A, E, R>) => STM<B, E, R>;
/**
* Dies with a `Cause.RuntimeException` having the specified message if the
* predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A>(predicate: Predicate<NoInfer<A>>, message: string): <E, R>(self: STM<A, E, R>) => STM<A, E, R>;
/**
* Dies with a `Cause.RuntimeException` having the specified message if the
* predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, B extends A>(self: STM<A, E, R>, refinement: Refinement<A, B>, message: string): STM<B, E, R>;
/**
* Dies with a `Cause.RuntimeException` having the specified message if the
* predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R>(self: STM<A, E, R>, predicate: Predicate<A>, message: string): STM<A, E, R>;
};
/**
* Supplies `orElse` if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
export declare const filterOrElse: {
/**
* Supplies `orElse` if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, B extends A, C, E2, R2>(refinement: Refinement<NoInfer<A>, B>, orElse: (a: NoInfer<A>) => STM<C, E2, R2>): <E, R>(self: STM<A, E, R>) => STM<B | C, E2 | E, R2 | R>;
/**
* Supplies `orElse` if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, B, E2, R2>(predicate: Predicate<NoInfer<A>>, orElse: (a: NoInfer<A>) => STM<B, E2, R2>): <E, R>(self: STM<A, E, R>) => STM<A | B, E2 | E, R2 | R>;
/**
* Supplies `orElse` if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, B extends A, C, E2, R2>(self: STM<A, E, R>, refinement: Refinement<A, B>, orElse: (a: A) => STM<C, E2, R2>): STM<B | C, E | E2, R | R2>;
/**
* Supplies `orElse` if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, B, E2, R2>(self: STM<A, E, R>, predicate: Predicate<A>, orElse: (a: A) => STM<B, E2, R2>): STM<A | B, E | E2, R | R2>;
};
/**
* Fails with the specified error if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
export declare const filterOrFail: {
/**
* Fails with the specified error if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, B extends A, E2>(refinement: Refinement<NoInfer<A>, B>, orFailWith: (a: NoInfer<A>) => E2): <E, R>(self: STM<A, E, R>) => STM<B, E2 | E, R>;
/**
* Fails with the specified error if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E2>(predicate: Predicate<NoInfer<A>>, orFailWith: (a: NoInfer<A>) => E2): <E, R>(self: STM<A, E, R>) => STM<A, E2 | E, R>;
/**
* Fails with the specified error if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, B extends A, E2>(self: STM<A, E, R>, refinement: Refinement<A, B>, orFailWith: (a: A) => E2): STM<B, E | E2, R>;
/**
* Fails with the specified error if the predicate fails.
*
* @since 2.0.0
* @category filtering
*/
<A, E, R, E2>(self: STM<A, E, R>, predicate: Predicate<A>, orFailWith: (a: A) => E2): STM<A, E | E2, R>;
};
/**
* Feeds the value produced by this effect to the specified function, and then
* runs the returned effect as well to produce its results.
*
* @since 2.0.0
* @category sequencing
*/
export declare const flatMap: {
/**
* Feeds the value produced by this effect to the specified function, and then
* runs the returned effect as well to produce its results.
*
* @since 2.0.0
* @category sequencing
*/
<A, A2, E1, R1>(f: (a: A) => STM<A2, E1, R1>): <E, R>(self: STM<A, E, R>) => STM<A2, E1 | E, R1 | R>;
/**
* Feeds the value produced by this effect to the specified function, and then
* runs the returned effect as well to produce its results.
*
* @since 2.0.0
* @category sequencing
*/
<A, E, R, A2, E1, R1>(self: STM<A, E, R>, f: (a: A) => STM<A2, E1, R1>): STM<A2, E | E1, R | R1>;
};
/**
* Flattens out a nested `STM` effect.
*
* @since 2.0.0
* @category sequencing
*/
export declare const flatten: <A, E2, R2, E, R>(self: STM<STM<A, E2, R2>, E, R>) => STM<A, E2 | E, R2 | R>;
/**
* Flips the success and failure channels of this transactional effect. This
* allows you to use all methods on the error channel, possibly before
* flipping back.
*
* @since 2.0.0
* @category mutations
*/
export declare const flip: <A, E, R>(self: STM<A, E, R>) => STM<E, A, R>;
/**
* Swaps the error/value parameters, applies the function `f` and flips the
* parameters back
*
* @since 2.0.0
* @category mutations
*/
export declare const flipWith: {
/**
* Swaps the error/value parameters, applies the function `f` and flips the
* parameters back
*
* @since 2.0.0
* @category mutations
*/
<E, A, R, E2, A2, R2>(f: (stm: STM<E, A, R>) => STM<E2, A2, R2>): (self: STM<A, E, R>) => STM<A | A2, E | E2, R | R2>;
/**
* Swaps the error/value parameters, applies the function `f` and flips the
* parameters back
*
* @since 2.0.0
* @category mutations
*/
<A, E, R, E2, A2, R2>(self: STM<A, E, R>, f: (stm: STM<E, A, R>) => STM<E2, A2, R2>): STM<A | A2, E | E2, R | R2>;
};
/**
* Folds over the `STM` effect, handling both failure and success, but not
* retry.
*
* @since 2.0.0
* @category folding
*/
export declare const match: {
/**
* Folds over the `STM` effect, handling both failure and success, but not
* retry.
*
* @since 2.0.0
* @category folding
*/
<E, A2, A, A3>(options: {
readonly onFailure: (error: E) => A2;
readonly onSuccess: (value: A) => A3;
}): <R>(self: STM<A, E, R>) => STM<A2 | A3, never, R>;
/**
* Folds over the `STM` effect, handling both failure and success, but not
* retry.
*
* @since 2.0.0
* @category folding
*/
<A, E, R, A2, A3>(self: STM<A, E, R>, options: {
readonly onFailure: (error: E) => A2;
readonly onSuccess: (value: A) => A3;
}): STM<A2 | A3, never, R>;
};
/**
* Effectfully folds over the `STM` effect, handling both failure and success.
*
* @since 2.0.0
* @category folding
*/
export declare const matchSTM: {
/**
* Effectfully folds over the `STM` effect, handling both failure and success.
*
* @since 2.0.0
* @category folding
*/
<E, A1, E1, R1, A, A2, E2, R2>(options: {
readonly onFailure: (e: E) => STM<A1, E1, R1>;
readonly onSuccess: (a: A) => STM<A2, E2, R2>;
}): <R>(self: STM<A, E, R>) => STM<A1 | A2, E1 | E2, R1 | R2 | R>;
/**
* Effectfully folds over the `STM` effect, handling both failure and success.
*
* @since 2.0.0
* @category folding
*/
<A, E, R, A1, E1, R1, A2, E2, R2>(self: STM<A, E, R>, options: {
readonly onFailure: (e: E) => STM<A1, E1, R1>;
readonly onSuccess: (a: A) => STM<A2, E2, R2>;
}): STM<A1 | A2, E1 | E2, R | R1 | R2>;
};
/**
* Applies the function `f` to each element of the `Iterable<A>` and returns
* a transactional effect that produces a new `Chunk<A2>`.
*
* @since 2.0.0
* @category traversing
*/
export declare const forEach: {
/**
* Applies the function `f` to each element of the `Iterable<A>` and returns
* a transactional effect that produces a new `Chunk<A2>`.
*
* @since 2.0.0
* @category traversing
*/
<A, A2, E, R>(f: (a: A) => STM<A2, E, R>, options?: {
readonly discard?: false | undefined;
} | undefined): (elements: Iterable<A>) => STM<Array<A2>, E, R>;
/**
* Applies the function `f` to each element of the `Iterable<A>` and returns
* a transactional effect that produces a new `Chunk<A2>`.
*
* @since 2.0.0
* @category traversing
*/
<A, A2, E, R>(f: (a: A) => STM<A2, E, R>, options: {
readonly discard: true;
}): (elements: Iterable<A>) => STM<void, E, R>;
/**
* Applies the function `f` to each element of the `Iterable<A>` and returns
* a transactional effect that produces a new `Chunk<A2>`.
*
* @since 2.0.0
* @category traversing
*/
<A, A2, E, R>(elements: Iterable<A>, f: (a: A) => STM<A2, E, R>, options?: {
readonly discard?: false | undefined;
} | undefined): STM<Array<A2>, E, R>;
/**
* Applies the function `f` to each element of the `Iterable<A>` and returns
* a transactional effect that produces a new `Chunk<A2>`.
*
* @since 2.0.0
* @category traversing
*/
<A, A2, E, R>(elements: Iterable<A>, f: (a: A) => STM<A2, E, R>, options: {
readonly discard: true;
}): STM<void, E, R>;
};
/**
* Lifts an `Either` into a `STM`.
*
* @since 2.0.0
* @category constructors
*/
export declare const fromEither: <A, E>(either: Either.Either<A, E>) => STM<A, E>;
/**
* Lifts an `Option` into a `STM`.
*
* @since 2.0.0
* @category constructors
*/
export declare const fromOption: <A>(option: Option.Option<A>) => STM<A, Option.Option<never>>;
/**
* @since 2.0.0
* @category models
*/
export interface Adapter {
<A, E, R>(self: STM<A, E, R>): STM<A, E, R>;
<A, _R, _E, _A>(a: A, ab: (a: A) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: F) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (g: H) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => P, pq: (p: P) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => P, pq: (p: P) => Q, qr: (q: Q) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => P, pq: (p: P) => Q, qr: (q: Q) => R, rs: (r: R) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => P, pq: (p: P) => Q, qr: (q: Q) => R, rs: (r: R) => S, st: (s: S) => STM<_A, _E, _R>): STM<_A, _E, _R>;
<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, _R, _E, _A>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E, ef: (e: E) => F, fg: (f: F) => G, gh: (g: G) => H, hi: (h: H) => I, ij: (i: I) => J, jk: (j: J) => K, kl: (k: K) => L, lm: (l: L) => M, mn: (m: M) => N, no: (n: N) => O, op: (o: O) => P, pq: (p: P) => Q, qr: (q: Q) => R, rs: (r: R) => S, st: (s: S) => T, tu: (s: T) => STM<_A, _E, _R>): STM<_A, _E, _R>;
}
/**
* @since 2.0.0
* @category constructors
*/
export declare const gen: <Self, Eff extends YieldWrap<STM<any, any, any>>, AEff>(...args: [
self: Self,
body: (this: Self, resume: Adapter) => Generator<Eff, AEff, never>
] | [body: (resume: Adapter) => Generator<Eff, AEff, never>]) => STM<AEff, [
Eff
] extends [never] ? never : [Eff] extends [YieldWrap<STM<infer _A, infer E, infer _R>>] ? E : never, [
Eff
] extends [never] ? never : [Eff] extends [YieldWrap<STM<infer _A, infer _E, infer R>>] ? R : never>;
/**
* Returns a successful effect with the head of the list if the list is
* non-empty or fails with the error `None` if the list is empty.
*
* @since 2.0.0
* @category getters
*/
export declare const head: <A, E, R>(self: STM<Iterable<A>, E, R>) => STM<A, Option.Option<E>, R>;
declare const if_: {
<A, E1, R1, A2, E2, R2>(options: {
readonly onTrue: STM<A, E1, R1>;
readonly onFalse: STM<A2, E2, R2>; /**
* Flattens out a nested `STM` effect.
*
* @since 2.0.0
* @category sequencing
*/
}): <E = never, R = never>(self: boolean | STM<boolean, E, R>) => STM<A | A2, E1 | E2 | E, R1 | R2 | R>;
<A, E1, R1, A2, E2, R2, E = never, R = never>(self: boolean, options: {
readonly onTrue: STM<A, E1, R1>;
readonly onFalse: STM<A2, E2, R2>;
}): STM<A | A2, E1 | E2 | E, R1 | R2 | R>;
<E, R, A, E1, R1, A2, E2, R2>(self: STM<boolean, E, R>, options: {
readonly onTrue: STM<A, E1, R1>;
readonly onFalse: STM<A2, E2, R2>;
}): STM<A | A2, E | E1 | E2, R | R1 | R2>;
};
export {
/**
* Runs `onTrue` if the result of `b` is `true` and `onFalse` otherwise.
*
* @since 2.0.0
* @category mutations
*/
if_ as if };
/**
* Returns a new effect that ignores the success or failure of this effect.
*
* @since 2.0.0
* @category mutations
*/
export declare const ignore: <A, E, R>(self: STM<A, E, R>) => STM<void, never, R>;
/**
* Interrupts the fiber running the effect.
*
* @since 2.0.0
* @category constructors
*/
export declare const interrupt: STM<never>;
/**
* Interrupts the fiber running the effect with the specified `FiberId`.
*
* @since 2.0.0
* @category constructors
*/
export declare const interruptAs: (fiberId: FiberId.FiberId) => STM<never>;
/**
* Returns whether this transactional effect is a failure.
*
* @since 2.0.0
* @category getters
*/
export declare const isFailure: <A, E, R>(self: STM<A, E, R>) => STM<boolean, never, R>;
/**
* Returns whether this transactional effect is a success.
*
* @since 2.0.0
* @category getters
*/
export declare const isSuccess: <A, E, R>(self: STM<A, E, R>) => STM<boolean, never, R>;
/**
* Iterates with the specified transactional function. The moral equivalent
* of:
*
* ```ts skip-type-checking
* const s = initial
*
* while (cont(s)) {
* s = body(s)
* }
*
* return s
* ```
*
* @since 2.0.0
* @category constructors
*/
export declare const iterate: <Z, E, R>(initial: Z, options: {
readonly while: Predicate<Z>;
readonly body: (z: Z) => STM<Z, E, R>;
}) => STM<Z, E, R>;
/**
* Loops with the specified transactional function, collecting the results
* into a list. The moral equivalent of:
*
* ```ts skip-type-checking
* const as = []
* let s = initial
*
* while (cont(s)) {
* as.push(body(s))
* s = inc(s)
* }
*
* return as
* ```
*
* @since 2.0.0
* @category constructors
*/
export declare const loop: {
/**
* Loops with the specified transactional function, collecting the results
* into a list. The moral equivalent of:
*
* ```ts skip-type-checking
* const as = []
* let s = initial
*
* while (cont(s)) {
* as.push(body(s))
* s = inc(s)
* }
*
* return as
* ```
*
* @since 2.0.0
* @category constructors
*/
<Z, A, E, R>(initial: Z, options: {
readonly while: (z: Z) => boolean;
readonly step: (z: Z) => Z;
readonly body: (z: Z) => STM<A, E, R>;
readonly discard?: false | undefined;
}): STM<Array<A>, E, R>;
/**
* Loops with the specified transactional function, collecting the results
* into a list. The moral equivalent of:
*
* ```ts skip-type-checking
* const as = []
* let s = initial
*
* while (cont(s)) {
* as.push(body(s))
* s = inc(s)
* }
*
* return as
* ```
*
* @since 2.0.0
* @category constructors
*/
<Z, A, E, R>(initial: Z, options: {
readonly while: (z: Z) => boolean;
readonly step: (z: Z) => Z;
readonly body: (z: Z) => STM<A, E, R>;
readonly discard: true;
}): STM<void, E, R>;
};
/**
* Maps the value produced by the effect.
*
* @since 2.0.0
* @category mapping
*/
export declare const map: {
/**
* Maps the value produced by the effect.
*
* @since 2.0.0
* @category mapping
*/
<A, B>(f: (a: A) => B): <E, R>(self: STM<A, E, R>) => STM<B, E, R>;
/**
* Maps the value produced by the effect.
*
* @since 2.0.0
* @category mapping
*/
<A, E, R, B>(self: STM<A, E, R>, f: (a: A) => B): STM<B, E, R>;
};
/**
* Maps the value produced by the effect with the specified function that may
* throw exceptions but is otherwise pure, translating any thrown exceptions
* into typed failed effects.
*
* @since 2.0.0
* @category mapping
*/
export declare const mapAttempt: {
/**
* Maps the value produced by the effect with the specified function that may
* throw exceptions but is otherwise pure, translating any thrown exceptions
* into typed failed effects.
*
* @since 2.0.0
* @category mapping
*/
<A, B>(f: (a: A) => B): <E, R>(self: STM<A, E, R>) => STM<B, unknown, R>;
/**
* Maps the value produced by the effect with the specified function that may
* throw exceptions but is otherwise pure, translating any thrown exceptions
* into typed failed effects.
*
* @since 2.0.0
* @category mapping
*/
<A, E, R, B>(self: STM<A, E, R>, f: (a: A) => B): STM<B, unknown, R>;
};
/**
* Returns an `STM` effect whose failure and success channels have been mapped
* by the specified pair of functions, `f` and `g`.
*
* @since 2.0.0
* @category mapping
*/
export declare const mapBoth: {
/**
* Returns an `STM` effect whose failure and success channels have been mapped
* by the specified pair of functions, `f` and `g`.
*
* @since 2.0.0
* @category mapping
*/
<E, E2, A, A2>(options: {
readonly onFailure: (error: E) => E2;
readonly onSuccess: (value: A) => A2;
}): <R>(self: STM<A, E, R>) => STM<A2, E2, R>;
/**
* Returns an `STM` effect whose failure and success channels have been mapped
* by the specified pair of functions, `f` and `g`.
*
* @since 2.0.0
* @category mapping
*/
<A, E, R, E2, A2>(self: STM<A, E, R>, options: {
readonly onFailure: (error: E) => E2;
readonly onSuccess: (value: A) => A2;
}): STM<A2, E2, R>;
};
/**
* Maps from one error type to another.
*
* @since 2.0.0
* @category mapping
*/
export declare const mapError: {
/**
* Maps from one error type to another.
*
* @since 2.0.0
* @category mapping
*/
<E, E2>(f: (error: E) => E2): <A, R>(self: STM<A, E, R>) => STM<A, E2, R>;
/**
* Maps from one error type to another.
*
* @since 2.0.0
* @category mapping
*/
<A, E, R, E2>(self: STM<A, E, R>, f: (error: E) => E2): STM<A, E2, R>;
};
/**
* Returns a new effect where the error channel has been merged into the
* success channel to their common combined type.
*
* @since 2.0.0
* @category mutations
*/
export declare const merge: <A, E, R>(self: STM<A, E, R>) => STM<E | A, never, R>;
/**
* Merges an `Iterable<STM>` to a single `STM`, working sequentially.
*
* @since 2.0.0
* @category constructors
*/
export declare const mergeAll: {
/**
* Merges an `Iterable<STM>` to a single `STM`, working sequentially.
*
* @since 2.0.0
* @category constructors
*/
<A2, A>(zero: A2, f: (a2: A2, a: A) => A2): <E, R>(iterable: Iterable<STM<A, E, R>>) => STM<A2, E, R>;
/**
* Merges an `Iterable<STM>` to a single `STM`, working sequentially.
*
* @since 2.0.0
* @category constructors
*/
<A, E, R, A2>(iterable: Iterable<STM<A, E, R>>, zero: A2, f: (a2: A2, a: A) => A2): STM<A2, E, R>;
};
/**
* Returns a new effect where boolean value of this effect is negated.
*
* @since 2.0.0
* @category mutations
*/
export declare const negate: <E, R>(self: STM<boolean, E, R>) => STM<boolean, E, R>;
/**
* Requires the option produced by this value to be `None`.
*
* @since 2.0.0
* @category mutations
*/
export declare const none: <A, E, R>(self: STM<Option.Option<A>, E, R>) => STM<void, Option.Option<E>, R>;
/**
* Converts the failure channel into an `Option`.
*
* @since 2.0.0
* @category mutations
*/
export declare const option: <A, E, R>(self: STM<A, E, R>) => STM<Option.Option<A>, never, R>;
/**
* Translates `STM` effect failure into death of the fiber, making all
* failures unchecked and not a part of the type of the effect.
*
* @since 2.0.0
* @category error handling
*/
export declare const orDie: <A, E, R>(self: STM<A, E, R>) => STM<A, never, R>;
/**
* Keeps none of the errors, and terminates the fiber running the `STM` effect
* with them, using the specified function to convert the `E` into a defect.
*
* @since 2.0.0
* @category error handling
*/
export declare const orDieWith: {
/**
* Keeps none of the errors, and terminates the fiber running the `STM` effect
* with them, using the specified function to convert the `E` into a defect.
*
* @since 2.0.0
* @category error handling
*/
<E>(f: (error: E) => unknown): <A, R>(self: STM<A, E, R>) => STM<A, never, R>;
/**
* Keeps none of the errors, and terminates the fiber running the `STM` effect
* with them, using the specified function to convert the `E` into a defect.
*
* @since 2.0.0
* @category error handling
*/
<A, E, R>(self: STM<A, E, R>, f: (error: E) => unknown): STM<A, never, R>;
};
/**
* Tries this effect first, and if it fails or retries, tries the other
* effect.
*
* @since 2.0.0
* @category error handling
*/
export declare const orElse: {
/**
* Tries this effect first, and if it fails or retrie