Interface Constructor<A>

Since

2.0.0

interface Constructor {
    [RefinedConstructorsTypeId]: typeof RefinedConstructorsTypeId;
    either(args): Either<BrandErrors, A>;
    is(a): a is Unbranded<A> & A;
    option(args): Option<A>;
    (args): A;
}

Type Parameters

in out A extends Brand<any>

Hierarchy

Constructor
- BrandSchema

Constructor(args): A
Constructs a branded type from a value of type A, throwing an error if the provided A is not valid.
Parameters
- args: Unbranded<A>
Returns A

Index

Methods

either is option

Properties

[RefinedConstructorsTypeId]

Methods

either

either(args): Either<BrandErrors, A>
Constructs a branded type from a value of type A, returning Right<A> if the provided A is valid, Left<BrandError> otherwise.
Parameters
- args: Unbranded<A>
Returns Either<BrandErrors, A>

is

is(a): a is Unbranded<A> & A
Attempts to refine the provided value of type A, returning true if the provided A is valid, false otherwise.
Parameters
- a: Unbranded<A>
Returns a is Unbranded<A> & A

option

option(args): Option<A>
Constructs a branded type from a value of type A, returning Some<A> if the provided A is valid, None otherwise.
Parameters
- args: Unbranded<A>
Returns Option<A>

Properties

`Readonly` [RefinedConstructorsTypeId]

[RefinedConstructorsTypeId]: typeof RefinedConstructorsTypeId