monad-ts/src/flow.d.ts

Monad-ts is a small library implements some of key monads and way to chain them in a pipe (flow) in JavaScript and TypeScript. Angular 2+ compatible.

import { Monad } from "./monad";
import { Maybe } from "./maybe";
import { ErrorM } from "./error";
import { MF } from "./types/mf";
/**
 * Class Flow - for composing monads in a flow (pipe).
 * @extends {Monad}
 */
export declare class Flow<T> extends Monad<T> {
    /**
     * @type {any}
     * @protected
     */
    protected flow: any;
    /**
     * @type {Maybe}
     * @protected
     */
    protected maybe: Maybe<T>;
    /**
     * @type {ErrorM}
     * @protected
     */
    protected err: ErrorM<T>;
    /**
     * Create an instance of class AsyncFlow.
     * @param {any} initV - initial value of new flow (pipe).
     * @param {boolean} [encapsulate = true] encapsulate - flag, if true then the init value will be cloned.
     */
    constructor(initV: any, encapsulate?: boolean);
    /**
     * Chains the operations on a monadic values.
     * @method bind
     * @param {function(v: T) => Pr<U>} f - transformation function for a main flow value.
     * @param {any} [v = this.flow] - underlying value for a monad.
     * @return {Flow<T>} transformed by f() value v or throw Error or null.
     */
    bind<T, U>(f: MF<T, U>, v?: any): Flow<T>;
    /**
     * Creates branch from a flow (pipe).
     * @method let
     * @param {function(v: T) => Pr<U>} f - transformation function for a main flow value.
     * @return {Flow<T>}
     */
    let<T, U>(f: MF<T, U>): Flow<T>;
    /**
     * Extract value from a flow (pipe).
     * @method subscribe
     * @return {T}
     */
    subscribe<T>(): T;
}