import {State} from 'monad-ts/src/state.js'

public class | source

State

Monad → State

Class State - it takes a state and returns an intermediate value and some new state value.

Constructor Summary

Public Constructor
public	constructor(state: Object) Creates an instance of the class State with an initialization or not, the initialization can be occur late with bind method.

Public Members
public	err: ErrorM The instance of ErrorM.
public	maybe: Maybe The instance of Maybe.
public	state: any Keeps the state of application variables.

Public Methods
public	bind(f: Function, v: *) It takes an initial state of the monad if monad has initialized in the constructor then function assigns Error to underlying value.
public	get(): Pr<T> \| Error Extracts the state of app.
public	put(f: function(v: T)) Changes the state of application variables, if you try add new key with put() to state object it'll be assigned with Error instance.

From class Monad
public abstract	bind(f: MF<T, U>\|D<T>, v: *): Promise<U> \| Pr<U> \| Error \| boolean \| void Binds transformation function and underlying value to the monad.
protected	fail(e: Error \| string): Error Takes Error or string return Error.
protected	just(f: function(v: T), v: T): Pr<U> Produces result after execution f(v).

Creates an instance of the class State with an initialization or not, the initialization can be occur late with bind method.

Name	Type	Attribute	Description
state	Object	optional	the initial state of app.

The instance of ErrorM.

The instance of Maybe.

Keeps the state of application variables.

It takes an initial state of the monad if monad has initialized in the constructor then function assigns Error to underlying value.

Name	Type	Attribute	Description
f	Function
v	*	optional	underlying value for the monad, it can be null.

Extracts the state of app.

Pr<T> | Error

Changes the state of application variables, if you try add new key with put() to state object it'll be assigned with Error instance.

Name	Type	Attribute	Description
f	function(v: T)		app. state transformation function.