Skip to content

Latest commit

 

History

History
2223 lines (1573 loc) · 40 KB

index.ts.md

File metadata and controls

2223 lines (1573 loc) · 40 KB
title nav_order parent
index.ts
1
Modules

Table of contents

Any (interface)

Signature

export interface Any extends Type<any, any, any> {}

Added in v1.0.0

AnyC (interface)

Signature

export interface AnyC extends AnyType {}

Added in v1.5.3

AnyProps (interface)

Signature

export interface AnyProps {
  [key: string]: Any
}

Added in v1.0.0

ArrayC (interface)

Signature

export interface ArrayC<C extends Mixed> extends ArrayType<C, Array<TypeOf<C>>, Array<OutputOf<C>>, unknown> {}

Added in v1.5.3

BooleanC (interface)

Signature

export interface BooleanC extends BooleanType {}

Added in v1.5.3

Brand (interface)

Signature

export interface Brand<B> {
  readonly [_brand]: B
}

Added in v1.8.1

BrandC (interface)

Signature

export interface BrandC<C extends Any, B> extends RefinementType<C, Branded<TypeOf<C>, B>, OutputOf<C>, InputOf<C>> {}

Added in v1.8.1

Context (interface)

Signature

export interface Context extends ReadonlyArray<ContextEntry> {}

Added in v1.0.0

ContextEntry (interface)

Signature

export interface ContextEntry {
  readonly key: string
  readonly type: Decoder<any, any>
  /** the input data */
  readonly actual?: unknown
}

Added in v1.0.0

Decoder (interface)

Signature

export interface Decoder<I, A> {
  readonly name: string
  readonly validate: Validate<I, A>
  readonly decode: Decode<I, A>
}

Added in v1.0.0

Encoder (interface)

Signature

export interface Encoder<A, O> {
  readonly encode: Encode<A, O>
}

Added in v1.0.0

Errors (interface)

Signature

export interface Errors extends Array<ValidationError> {}

Added in v1.0.0

ExactC (interface)

Signature

export interface ExactC<C extends HasProps> extends ExactType<C, TypeOf<C>, OutputOf<C>, InputOf<C>> {}

Added in v1.5.3

FunctionC (interface)

Signature

export interface FunctionC extends FunctionType {}

Added in v1.5.3

HasPropsExact (interface)

Signature

export interface HasPropsExact extends ExactType<HasProps, any, any, any> {}

Added in v2.1.0

HasPropsIntersection (interface)

Signature

export interface HasPropsIntersection extends IntersectionType<Array<HasProps>, any, any, any> {}

Added in v1.1.0

HasPropsReadonly (interface)

Signature

export interface HasPropsReadonly extends ReadonlyType<HasProps, any, any, any> {}

Added in v1.1.0

HasPropsRecursive (interface)

Signature

export interface HasPropsRecursive extends RecursiveType<HasProps, any, any, any> {}

Added in v2.1.0

HasPropsRefinement (interface)

Signature

export interface HasPropsRefinement extends RefinementType<HasProps, any, any, any> {}

Added in v1.1.0

IntBrand (interface)

Signature

export interface IntBrand {
  readonly Int: unique symbol
}

Added in v1.8.1

IntersectionC (interface)

Signature

export interface IntersectionC<CS extends [Mixed, Mixed, ...Array<Mixed>]>
  extends IntersectionType<
    CS,
    CS extends { length: 2 }
      ? TypeOf<CS[0]> & TypeOf<CS[1]>
      : CS extends { length: 3 }
      ? TypeOf<CS[0]> & TypeOf<CS[1]> & TypeOf<CS[2]>
      : CS extends { length: 4 }
      ? TypeOf<CS[0]> & TypeOf<CS[1]> & TypeOf<CS[2]> & TypeOf<CS[3]>
      : CS extends { length: 5 }
      ? TypeOf<CS[0]> & TypeOf<CS[1]> & TypeOf<CS[2]> & TypeOf<CS[3]> & TypeOf<CS[4]>
      : unknown,
    CS extends { length: 2 }
      ? OutputOf<CS[0]> & OutputOf<CS[1]>
      : CS extends { length: 3 }
      ? OutputOf<CS[0]> & OutputOf<CS[1]> & OutputOf<CS[2]>
      : CS extends { length: 4 }
      ? OutputOf<CS[0]> & OutputOf<CS[1]> & OutputOf<CS[2]> & OutputOf<CS[3]>
      : CS extends { length: 5 }
      ? OutputOf<CS[0]> & OutputOf<CS[1]> & OutputOf<CS[2]> & OutputOf<CS[3]> & OutputOf<CS[4]>
      : unknown,
    unknown
  > {}

Added in v1.5.3

KeyofC (interface)

Signature

export interface KeyofC<D extends { [key: string]: unknown }> extends KeyofType<D> {}

Added in v1.5.3

LiteralC (interface)

Signature

export interface LiteralC<V extends LiteralValue> extends LiteralType<V> {}

Added in v1.5.3

Mixed (interface)

Signature

export interface Mixed extends Type<any, any, unknown> {}

Added in v1.0.0

NeverC (interface)

Signature

export interface NeverC extends NeverType {}

Added in v1.5.3

NullC (interface)

Signature

export interface NullC extends NullType {}

Added in v1.5.3

NumberC (interface)

Signature

export interface NumberC extends NumberType {}

Added in v1.5.3

ObjectC (interface)

Signature

export interface ObjectC extends ObjectType {}

Added in v1.5.3

PartialC (interface)

Signature

export interface PartialC<P extends Props>
  extends PartialType<P, { [K in keyof P]?: TypeOf<P[K]> }, { [K in keyof P]?: OutputOf<P[K]> }, unknown> {}

Added in v1.5.3

Props (interface)

Signature

export interface Props {
  [key: string]: Mixed
}

Added in v1.0.0

ReadonlyArrayC (interface)

Signature

export interface ReadonlyArrayC<C extends Mixed>
  extends ReadonlyArrayType<C, ReadonlyArray<TypeOf<C>>, ReadonlyArray<OutputOf<C>>, unknown> {}

Added in v1.5.3

ReadonlyC (interface)

Signature

export interface ReadonlyC<C extends Mixed>
  extends ReadonlyType<
    C,
    { readonly [K in keyof TypeOf<C>]: TypeOf<C>[K] },
    { readonly [K in keyof OutputOf<C>]: OutputOf<C>[K] },
    unknown
  > {}

Added in v1.5.3

RecordC (interface)

Signature

export interface RecordC<D extends Mixed, C extends Mixed>
  extends DictionaryType<D, C, { [K in TypeOf<D>]: TypeOf<C> }, { [K in OutputOf<D>]: OutputOf<C> }, unknown> {}

Added in v1.5.3

RefinementC (interface)

Use BrandC instead

Signature

export interface RefinementC<C extends Any> extends RefinementType<C, TypeOf<C>, OutputOf<C>, InputOf<C>> {}

Added in v1.5.3

StrictC (interface)

Signature

export interface StrictC<P extends Props>  // tslint:disable-next-line: deprecation
  extends StrictType<P, { [K in keyof P]: TypeOf<P[K]> }, { [K in keyof P]: OutputOf<P[K]> }, unknown> {}

Added in v1.5.3

StringC (interface)

Signature

export interface StringC extends StringType {}

Added in v1.5.3

TaggedExact (interface)

Signature

export interface TaggedExact<Tag extends string, A, O = A> extends ExactType<Tagged<Tag>, A, O> {}

Added in v1.3.0

TaggedIntersection (interface)

Signature

export interface TaggedIntersection<Tag extends string, A, O = A>  // tslint:disable-next-line: deprecation
  extends IntersectionType<TaggedIntersectionArgument<Tag>, A, O> {}

Added in v1.3.0

TaggedRefinement (interface)

Signature

export interface TaggedRefinement<Tag extends string, A, O = A> extends RefinementType<Tagged<Tag>, A, O> {}

Added in v1.3.0

TaggedUnion (interface)

Signature

export interface TaggedUnion<Tag extends string, A, O = A> extends UnionType<Array<Tagged<Tag>>, A, O> {}

Added in v1.3.0

TaggedUnionC (interface)

Signature

export interface TaggedUnionC<Tag extends string, CS extends [Mixed, Mixed, ...Array<Mixed>]>  // tslint:disable-next-line: deprecation
  extends TaggedUnionType<Tag, CS, TypeOf<CS[number]>, OutputOf<CS[number]>, unknown> {}

Added in v1.5.3

TupleC (interface)

Signature

export interface TupleC<CS extends [Mixed, ...Array<Mixed>]>
  extends TupleType<
    CS,
    CS extends { length: 1 }
      ? [TypeOf<CS[0]>]
      : CS extends { length: 2 }
      ? [TypeOf<CS[0]>, TypeOf<CS[1]>]
      : CS extends { length: 3 }
      ? [TypeOf<CS[0]>, TypeOf<CS[1]>, TypeOf<CS[2]>]
      : CS extends { length: 4 }
      ? [TypeOf<CS[0]>, TypeOf<CS[1]>, TypeOf<CS[2]>, TypeOf<CS[3]>]
      : CS extends { length: 5 }
      ? [TypeOf<CS[0]>, TypeOf<CS[1]>, TypeOf<CS[2]>, TypeOf<CS[3]>, TypeOf<CS[4]>]
      : unknown,
    CS extends { length: 1 }
      ? [OutputOf<CS[0]>]
      : CS extends { length: 2 }
      ? [OutputOf<CS[0]>, OutputOf<CS[1]>]
      : CS extends { length: 3 }
      ? [OutputOf<CS[0]>, OutputOf<CS[1]>, OutputOf<CS[2]>]
      : CS extends { length: 4 }
      ? [OutputOf<CS[0]>, OutputOf<CS[1]>, OutputOf<CS[2]>, OutputOf<CS[3]>]
      : CS extends { length: 5 }
      ? [OutputOf<CS[0]>, OutputOf<CS[1]>, OutputOf<CS[2]>, OutputOf<CS[3]>, OutputOf<CS[4]>]
      : unknown,
    unknown
  > {}

Added in v1.5.3

TypeC (interface)

Signature

export interface TypeC<P extends Props>
  extends InterfaceType<P, { [K in keyof P]: TypeOf<P[K]> }, { [K in keyof P]: OutputOf<P[K]> }, unknown> {}

Added in v1.5.3

UndefinedC (interface)

Signature

export interface UndefinedC extends UndefinedType {}

Added in v1.5.3

UnionC (interface)

Signature

export interface UnionC<CS extends [Mixed, Mixed, ...Array<Mixed>]>
  extends UnionType<CS, TypeOf<CS[number]>, OutputOf<CS[number]>, unknown> {}

Added in v1.5.3

UnknownArrayC (interface)

Signature

export interface UnknownArrayC extends AnyArrayType {}

Added in v1.5.3

UnknownC (interface)

Signature

export interface UnknownC extends UnknownType {}

Added in v1.5.3

UnknownRecordC (interface)

Signature

export interface UnknownRecordC extends AnyDictionaryType {}

Added in v1.5.3

ValidationError (interface)

Signature

export interface ValidationError {
  /** the offending (sub)value */
  readonly value: unknown
  /** where the error originated */
  readonly context: Context
  /** optional custom error message */
  readonly message?: string
}

Added in v1.0.0

VoidC (interface)

Signature

export interface VoidC extends VoidType {}

Added in v1.5.3

Branded (type alias)

Signature

export type Branded<A, B> = A & Brand<B>

Added in v1.8.1

Compact (type alias)

used in intersection as a workaround for #234

Signature

export type Compact<A> = { [K in keyof A]: A[K] }

Added in v1.4.2

Decode (type alias)

Signature

export type Decode<I, A> = (i: I) => Validation<A>

Added in v1.0.0

Encode (type alias)

Signature

export type Encode<A, O> = (a: A) => O

Added in v1.0.0

Exact (type alias)

Signature

export type Exact<T, X extends T> = T &
  { [K in ({ [K in keyof X]: K } & { [K in keyof T]: never } & { [key: string]: never })[keyof X]]?: never }

Added in v1.1.0

HasProps (type alias)

Signature

export type HasProps =
  | HasPropsRefinement
  | HasPropsReadonly
  | HasPropsIntersection
  | HasPropsRecursive
  | HasPropsExact
  | InterfaceType<any, any, any, any>
  // tslint:disable-next-line: deprecation
  | StrictType<any, any, any, any>
  | PartialType<any, any, any, any>

Added in v1.1.0

InputOf (type alias)

Signature

export type InputOf<C extends Any> = C['_I']

Added in v1.0.0

Int (type alias)

Signature

export type Int = Branded<number, IntBrand>

Added in v1.8.1

Is (type alias)

Signature

export type Is<A> = (u: unknown) => u is A

Added in v1.0.0

OutputOf (type alias)

Signature

export type OutputOf<C extends Any> = C['_O']

Added in v1.0.0

OutputOfDictionary (type alias)

Signature

export type OutputOfDictionary<D extends Any, C extends Any> = { [K in OutputOf<D>]: OutputOf<C> }

Added in v1.0.0

OutputOfPartialProps (type alias)

Signature

export type OutputOfPartialProps<P extends AnyProps> = { [K in keyof P]?: OutputOf<P[K]> }

Added in v1.0.0

OutputOfProps (type alias)

Signature

export type OutputOfProps<P extends AnyProps> = { [K in keyof P]: OutputOf<P[K]> }

Added in v1.0.0

PropsOf (type alias)

Signature

export type PropsOf<T extends { props: any }> = T['props']

Added in v1.0.0

Tagged (type alias)

Signature

export type Tagged<Tag extends string, A = any, O = A> =
  // tslint:disable-next-line: deprecation
  | InterfaceType<TaggedProps<Tag>, A, O>
  // tslint:disable-next-line: deprecation
  | StrictType<TaggedProps<Tag>, A, O>
  // tslint:disable-next-line: deprecation
  | TaggedRefinement<Tag, A, O>
  // tslint:disable-next-line: deprecation
  | TaggedUnion<Tag, A, O>
  // tslint:disable-next-line: deprecation
  | TaggedIntersection<Tag, A, O>
  // tslint:disable-next-line: deprecation
  | TaggedExact<Tag, A, O>
  | RecursiveType<any, A, O>

Added in v1.3.0

TaggedIntersectionArgument (type alias)

Signature

export type TaggedIntersectionArgument<Tag extends string> =
  // tslint:disable-next-line: deprecation
  | [Tagged<Tag>]
  // tslint:disable-next-line: deprecation
  | [Tagged<Tag>, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Tagged<Tag>]
  // tslint:disable-next-line: deprecation
  | [Tagged<Tag>, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Tagged<Tag>, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Tagged<Tag>]
  // tslint:disable-next-line: deprecation
  | [Tagged<Tag>, Mixed, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Tagged<Tag>, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Tagged<Tag>, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Mixed, Tagged<Tag>]
  // tslint:disable-next-line: deprecation
  | [Tagged<Tag>, Mixed, Mixed, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Tagged<Tag>, Mixed, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Tagged<Tag>, Mixed, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Mixed, Tagged<Tag>, Mixed]
  // tslint:disable-next-line: deprecation
  | [Mixed, Mixed, Mixed, Mixed, Tagged<Tag>]

Added in v1.3.0

TaggedProps (type alias)

Signature

export type TaggedProps<Tag extends string> = { [K in Tag]: LiteralType<any> }

Added in v1.3.0

TypeOf (type alias)

Signature

export type TypeOf<C extends Any> = C['_A']

Added in v1.0.0

TypeOfDictionary (type alias)

Signature

export type TypeOfDictionary<D extends Any, C extends Any> = { [K in TypeOf<D>]: TypeOf<C> }

Added in v1.0.0

TypeOfPartialProps (type alias)

Signature

export type TypeOfPartialProps<P extends AnyProps> = { [K in keyof P]?: TypeOf<P[K]> }

Added in v1.0.0

TypeOfProps (type alias)

Signature

export type TypeOfProps<P extends AnyProps> = { [K in keyof P]: TypeOf<P[K]> }

Added in v1.0.0

Validate (type alias)

Signature

export type Validate<I, A> = (i: I, context: Context) => Validation<A>

Added in v1.0.0

Validation (type alias)

Signature

export type Validation<A> = Either<Errors, A>

Added in v1.0.0

mixed (type alias)

Use unknown instead

Signature

export type mixed = unknown

Added in v1.0.0

AnyArrayType (class)

Signature

export class AnyArrayType {
  constructor() { ... }
  ...
}

Added in v1.0.0

AnyDictionaryType (class)

Signature

export class AnyDictionaryType {
  constructor() { ... }
  ...
}

Added in v1.0.0

AnyType (class)

Signature

export class AnyType {
  constructor() { ... }
  ...
}

Added in v1.0.0

ArrayType (class)

Signature

export class ArrayType<C, A, O, I> {
  constructor(
    name: string,
    is: ArrayType<C, A, O, I>['is'],
    validate: ArrayType<C, A, O, I>['validate'],
    encode: ArrayType<C, A, O, I>['encode'],
    readonly type: C
  ) { ... }
  ...
}

Added in v1.0.0

BooleanType (class)

Signature

export class BooleanType {
  constructor() { ... }
  ...
}

Added in v1.0.0

DictionaryType (class)

Signature

export class DictionaryType<D, C, A, O, I> {
  constructor(
    name: string,
    is: DictionaryType<D, C, A, O, I>['is'],
    validate: DictionaryType<D, C, A, O, I>['validate'],
    encode: DictionaryType<D, C, A, O, I>['encode'],
    readonly domain: D,
    readonly codomain: C
  ) { ... }
  ...
}

Added in v1.0.0

ExactType (class)

Signature

export class ExactType<C, A, O, I> {
  constructor(
    name: string,
    is: ExactType<C, A, O, I>['is'],
    validate: ExactType<C, A, O, I>['validate'],
    encode: ExactType<C, A, O, I>['encode'],
    readonly type: C
  ) { ... }
  ...
}

Added in v1.1.0

FunctionType (class)

Signature

export class FunctionType {
  constructor() { ... }
  ...
}

Added in v1.0.0

InterfaceType (class)

Signature

export class InterfaceType<P, A, O, I> {
  constructor(
    name: string,
    is: InterfaceType<P, A, O, I>['is'],
    validate: InterfaceType<P, A, O, I>['validate'],
    encode: InterfaceType<P, A, O, I>['encode'],
    readonly props: P
  ) { ... }
  ...
}

Added in v1.0.0

IntersectionType (class)

Signature

export class IntersectionType<CS, A, O, I> {
  constructor(
    name: string,
    is: IntersectionType<CS, A, O, I>['is'],
    validate: IntersectionType<CS, A, O, I>['validate'],
    encode: IntersectionType<CS, A, O, I>['encode'],
    readonly types: CS
  ) { ... }
  ...
}

Added in v1.0.0

KeyofType (class)

Signature

export class KeyofType<D> {
  constructor(
    name: string,
    is: KeyofType<D>['is'],
    validate: KeyofType<D>['validate'],
    encode: KeyofType<D>['encode'],
    readonly keys: D
  ) { ... }
  ...
}

Added in v1.0.0

LiteralType (class)

Signature

export class LiteralType<V> {
  constructor(
    name: string,
    is: LiteralType<V>['is'],
    validate: LiteralType<V>['validate'],
    encode: LiteralType<V>['encode'],
    readonly value: V
  ) { ... }
  ...
}

Added in v1.0.0

NeverType (class)

Signature

export class NeverType {
  constructor() { ... }
  ...
}

Added in v1.0.0

NullType (class)

Signature

export class NullType {
  constructor() { ... }
  ...
}

Added in v1.0.0

NumberType (class)

Signature

export class NumberType {
  constructor() { ... }
  ...
}

Added in v1.0.0

ObjectType (class)

Signature

export class ObjectType {
  constructor() { ... }
  ...
}

Added in v1.0.0

PartialType (class)

Signature

export class PartialType<P, A, O, I> {
  constructor(
    name: string,
    is: PartialType<P, A, O, I>['is'],
    validate: PartialType<P, A, O, I>['validate'],
    encode: PartialType<P, A, O, I>['encode'],
    readonly props: P
  ) { ... }
  ...
}

Added in v1.0.0

ReadonlyArrayType (class)

Signature

export class ReadonlyArrayType<C, A, O, I> {
  constructor(
    name: string,
    is: ReadonlyArrayType<C, A, O, I>['is'],
    validate: ReadonlyArrayType<C, A, O, I>['validate'],
    encode: ReadonlyArrayType<C, A, O, I>['encode'],
    readonly type: C
  ) { ... }
  ...
}

Added in v1.0.0

ReadonlyType (class)

Signature

export class ReadonlyType<C, A, O, I> {
  constructor(
    name: string,
    is: ReadonlyType<C, A, O, I>['is'],
    validate: ReadonlyType<C, A, O, I>['validate'],
    encode: ReadonlyType<C, A, O, I>['encode'],
    readonly type: C
  ) { ... }
  ...
}

Added in v1.0.0

RecursiveType (class)

Signature

export class RecursiveType<C, A, O, I> {
  constructor(
    name: string,
    is: RecursiveType<C, A, O, I>['is'],
    validate: RecursiveType<C, A, O, I>['validate'],
    encode: RecursiveType<C, A, O, I>['encode'],
    private runDefinition: () => C
  ) { ... }
  ...
}

Added in v1.0.0

RefinementType (class)

Signature

export class RefinementType<C, A, O, I> {
  constructor(
    name: string,
    is: RefinementType<C, A, O, I>['is'],
    validate: RefinementType<C, A, O, I>['validate'],
    encode: RefinementType<C, A, O, I>['encode'],
    readonly type: C,
    readonly predicate: Predicate<A>
  ) { ... }
  ...
}

Added in v1.0.0

StrictType (class)

Signature

export class StrictType<P, A, O, I> {
  constructor(
    name: string,
    // tslint:disable-next-line: deprecation
    is: StrictType<P, A, O, I>['is'],
    // tslint:disable-next-line: deprecation
    validate: StrictType<P, A, O, I>['validate'],
    // tslint:disable-next-line: deprecation
    encode: StrictType<P, A, O, I>['encode'],
    readonly props: P
  ) { ... }
  ...
}

Added in v1.0.0

StringType (class)

Signature

export class StringType {
  constructor() { ... }
  ...
}

Added in v1.0.0

TaggedUnionType (class)

Signature

export class TaggedUnionType<Tag, CS, A, O, I> {
  constructor(
    name: string,
    // tslint:disable-next-line: deprecation
    is: TaggedUnionType<Tag, CS, A, O, I>['is'],
    // tslint:disable-next-line: deprecation
    validate: TaggedUnionType<Tag, CS, A, O, I>['validate'],
    // tslint:disable-next-line: deprecation
    encode: TaggedUnionType<Tag, CS, A, O, I>['encode'],
    codecs: CS,
    readonly tag: Tag
  ) { ... }
  ...
}

Added in v1.3.0

TupleType (class)

Signature

export class TupleType<CS, A, O, I> {
  constructor(
    name: string,
    is: TupleType<CS, A, O, I>['is'],
    validate: TupleType<CS, A, O, I>['validate'],
    encode: TupleType<CS, A, O, I>['encode'],
    readonly types: CS
  ) { ... }
  ...
}

Added in v1.0.0

Type (class)

Signature

export class Type<A, O, I> {
  constructor(
    /** a unique name for this codec */
    readonly name: string,
    /** a custom type guard */
    readonly is: Is<A>,
    /** succeeds if a value of type I can be decoded to a value of type A */
    readonly validate: Validate<I, A>,
    /** converts a value of type A to a value of type O */
    readonly encode: Encode<A, O>
  ) { ... }
  ...
}

Added in v1.0.0

pipe (method)

Signature

pipe<B, IB, A extends IB, OB extends A>(
    this: Type<A, O, I>,
    ab: Type<B, OB, IB>,
    name: string = `pipe(${this.name}, ${ab.name})`
  ): Type<B, O, I> { ... }

Added in v1.0.0

asDecoder (method)

Signature

asDecoder(): Decoder<I, A> { ... }

Added in v1.0.0

asEncoder (method)

Signature

asEncoder(): Encoder<A, O> { ... }

Added in v1.0.0

decode (method)

a version of validate with a default context

Signature

decode(i: I): Validation<A> { ... }

Added in v1.0.0

UndefinedType (class)

Signature

export class UndefinedType {
  constructor() { ... }
  ...
}

Added in v1.0.0

UnionType (class)

Signature

export class UnionType<CS, A, O, I> {
  constructor(
    name: string,
    is: UnionType<CS, A, O, I>['is'],
    validate: UnionType<CS, A, O, I>['validate'],
    encode: UnionType<CS, A, O, I>['encode'],
    readonly types: CS
  ) { ... }
  ...
}

Added in v1.0.0

UnknownType (class)

Signature

export class UnknownType {
  constructor() { ... }
  ...
}

Added in v1.5.0

VoidType (class)

Signature

export class VoidType {
  constructor() { ... }
  ...
}

Added in v1.2.0

Dictionary (constant)

Use UnknownRecord instead

Signature

export const Dictionary: UnknownRecordC = ...

Added in v1.0.0

Function (constant)

Signature

export const Function: FunctionC = ...

Added in v1.0.0

Int (constant)

A branded codec representing an integer

Signature

export const Int: BrandC<NumberC, IntBrand> = ...

Added in v1.8.1

Integer (constant)

Use Int instead

Signature

export const Integer: RefinementC<NumberC> = ...

Added in v1.0.0

UnknownArray (constant)

Signature

export const UnknownArray: UnknownArrayC = ...

Added in v1.7.1

UnknownRecord (constant)

Signature

export const UnknownRecord: UnknownRecordC = ...

Added in v1.7.1

any (constant)

Use unknown instead

Signature

export const any: AnyC = ...

Added in v1.0.0

boolean (constant)

Signature

export const boolean: BooleanC = ...

Added in v1.0.0

dictionary (constant)

Use record instead

Signature

export const dictionary: typeof record = ...

Added in v1.0.0

failures (constant)

Signature

export const failures: <T>(errors: Errors) => Validation<T> = ...

Added in v1.0.0

never (constant)

Signature

export const never: NeverC = ...

Added in v1.0.0

nullType (constant)

Signature

export const nullType: NullC = ...

Added in v1.0.0

number (constant)

Signature

export const number: NumberC = ...

Added in v1.0.0

object (constant)

Use UnknownRecord instead

Signature

export const object: ObjectC = ...

Added in v1.0.0

string (constant)

Signature

export const string: StringC = ...

Added in v1.0.0

success (constant)

Signature

export const success: <T>(value: T) => Validation<T> = ...

Added in v1.0.0

unknown (constant)

Signature

export const unknown: UnknownC = ...

Added in v1.5.0

voidType (constant)

Signature

export const voidType: VoidC = ...

Added in v1.2.0

alias (function)

Keeps the codec "kind"

Signature

export function alias<A, O, P, I>(
  codec: PartialType<P, A, O, I>
): <
  // tslint:disable-next-line: deprecation
  AA extends Exact<A, AA>,
  // tslint:disable-next-line: deprecation
  OO extends Exact<O, OO> = O,
  // tslint:disable-next-line: deprecation
  PP extends Exact<P, PP> = P,
  II extends I = I
>() => PartialType<PP, AA, OO, II>
export function alias<A, O, P, I>(
  // tslint:disable-next-line: deprecation
  codec: StrictType<P, A, O, I>
): <
  // tslint:disable-next-line: deprecation
  AA extends Exact<A, AA>,
  // tslint:disable-next-line: deprecation
  OO extends Exact<O, OO> = O,
  // tslint:disable-next-line: deprecation
  PP extends Exact<P, PP> = P,
  II extends I = I
>() => // tslint:disable-next-line: deprecation
StrictType<PP, AA, OO, II>
export function alias<A, O, P, I>(
  codec: InterfaceType<P, A, O, I>
): <
  // tslint:disable-next-line: deprecation
  AA extends Exact<A, AA>,
  // tslint:disable-next-line: deprecation
  OO extends Exact<O, OO> = O,
  // tslint:disable-next-line: deprecation
  PP extends Exact<P, PP> = P,
  II extends I = I
>() => InterfaceType<PP, AA, OO, II> { ... }

Added in v1.1.0

appendContext (function)

Signature

export const appendContext = (c: Context, key: string, decoder: Decoder<any, any>, actual?: unknown): Context => ...

Added in v1.0.0

array (function)

Signature

export const array = <C extends Mixed>(codec: C, name: string = `Array<${codec.name}>`): ArrayC<C> =>
  new ArrayType(
    name,
    (u): u is Array<TypeOf<C>> => UnknownArray.is(u) && u.every(codec.is),
    (u, c) =>
      chain(UnknownArray.validate(u, c), us => ...

Added in v1.0.0

brand (function)

Signature

export const brand = <C extends Any, N extends string, B extends { readonly [K in N]: symbol }>(
  codec: C,
  predicate: Refinement<TypeOf<C>, Branded<TypeOf<C>, B>>,
  name: N
): BrandC<C, B> => ...

Added in v1.8.1

clean (function)

Drops the codec "kind"

Signature

export function clean<A, O = A, I = unknown>(codec: Type<A, O, I>): Type<A, O, I> { ... }

Added in v1.1.0

exact (function)

Strips additional properties

Signature

export const exact = <C extends HasProps>(codec: C, name: string = getExactTypeName(codec)): ExactC<C> => ...

Added in v1.1.0

failure (function)

Signature

export const failure = <T>(value: unknown, context: Context, message?: string): Validation<T> => ...

Added in v1.0.0

getContextEntry (function)

Signature

export const getContextEntry = (key: string, decoder: Decoder<any, any>): ContextEntry => ...

Added in v1.0.0

getDefaultContext (function)

Signature

export const getDefaultContext /* istanbul ignore next */ = (decoder: Decoder<any, any>): Context => ...

Added in v1.0.0

getFunctionName (function)

Signature

export const getFunctionName = (f: Function): string => ...

Added in v1.0.0

getValidationError (function)

Signature

export const getValidationError /* istanbul ignore next */ = (value: unknown, context: Context): ValidationError => ...

Added in v1.0.0

identity (function)

Signature

export const identity = <A>(a: A): A => ...

Added in v1.0.0

intersection (function)

Signature

export function intersection<A extends Mixed, B extends Mixed, C extends Mixed, D extends Mixed, E extends Mixed>(
  codecs: [A, B, C, D, E],
  name?: string
): IntersectionC<[A, B, C, D, E]>
export function intersection<A extends Mixed, B extends Mixed, C extends Mixed, D extends Mixed>(
  codecs: [A, B, C, D],
  name?: string
): IntersectionC<[A, B, C, D]>
export function intersection<A extends Mixed, B extends Mixed, C extends Mixed>(
  codecs: [A, B, C],
  name?: string
): IntersectionC<[A, B, C]>
export function intersection<A extends Mixed, B extends Mixed>(codecs: [A, B], name?: string): IntersectionC<[A, B]> { ... }

Added in v1.0.0

keyof (function)

Signature

export const keyof = <D extends { [key: string]: unknown }>(
  keys: D,
  name: string = Object.keys(keys)
    .map(k => JSON.stringify(k))
    .join(' | ')
): KeyofC<D> => ...

Added in v1.0.0

literal (function)

Signature

export const literal = <V extends LiteralValue>(value: V, name: string = JSON.stringify(value)): LiteralC<V> => ...

Added in v1.0.0

partial (function)

Signature

export const partial = <P extends Props>(
  props: P,
  name: string = getPartialTypeName(getInterfaceTypeName(props))
): PartialC<P> => ...

Added in v1.0.0

readonly (function)

Signature

export const readonly = <C extends Mixed>(codec: C, name: string = `Readonly<${codec.name}>`): ReadonlyC<C> => ...

Added in v1.0.0

readonlyArray (function)

Signature

export const readonlyArray = <C extends Mixed>(
  codec: C,
  name: string = `ReadonlyArray<${codec.name}>`
): ReadonlyArrayC<C> => ...

Added in v1.0.0

record (function)

Signature

export const record = <D extends Mixed, C extends Mixed>(
  domain: D,
  codomain: C,
  name: string = `{ [K in ${domain.name}]: ${codomain.name} }`
): RecordC<D, C> => ...

Added in v1.7.1

recursion (function)

Signature

export const recursion = <A, O = A, I = unknown, C extends Type<A, O, I> = Type<A, O, I>>(
  name: string,
  definition: (self: C) => C
): RecursiveType<C, A, O, I> => ...

Added in v1.0.0

refinement (function)

Use brand instead

Signature

export function refinement<C extends Any>(
  codec: C,
  predicate: Predicate<TypeOf<C>>,
  name: string = `(${codec.name} | ${getFunctionName(predicate)})`
): // tslint:disable-next-line: deprecation
RefinementC<C> { ... }

Added in v1.0.0

strict (function)

Strips additional properties

Signature

export const strict = <P extends Props>(props: P, name?: string): ExactC<TypeC<P>> => ...

Added in v1.0.0

taggedUnion (function)

Use union instead

Signature

export const taggedUnion = <Tag extends string, CS extends [Mixed, Mixed, ...Array<Mixed>]>(
  tag: Tag,
  codecs: CS,
  name: string = getUnionName(codecs)
  // tslint:disable-next-line: deprecation
): TaggedUnionC<Tag, CS> => ...

Added in v1.3.0

tuple (function)

Signature

export function tuple<A extends Mixed, B extends Mixed, C extends Mixed, D extends Mixed, E extends Mixed>(
  codecs: [A, B, C, D, E],
  name?: string
): TupleC<[A, B, C, D, E]>
export function tuple<A extends Mixed, B extends Mixed, C extends Mixed, D extends Mixed>(
  codecs: [A, B, C, D],
  name?: string
): TupleC<[A, B, C, D]>
export function tuple<A extends Mixed, B extends Mixed, C extends Mixed>(
  codecs: [A, B, C],
  name?: string
): TupleC<[A, B, C]>
export function tuple<A extends Mixed, B extends Mixed>(codecs: [A, B], name?: string): TupleC<[A, B]>
export function tuple<A extends Mixed>(codecs: [A], name?: string): TupleC<[A]> { ... }

Added in v1.0.0

type (function)

Signature

export const type = <P extends Props>(props: P, name: string = getInterfaceTypeName(props)): TypeC<P> => ...

Added in v1.0.0

union (function)

Signature

export const union = <CS extends [Mixed, Mixed, ...Array<Mixed>]>(
  codecs: CS,
  name: string = getUnionName(codecs)
): UnionC<CS> => ...

Added in v1.0.0

Array (export)

Use UnknownArray instead

Signature

UnknownArrayC

Added in v1.0.0

interface (export)

Use type instead

Signature

<P extends Props>(props: P, name?: string) => TypeC<P>

Added in v1.0.0

null (export)

Signature

NullC

Added in v1.0.0

undefined (export)

Signature

UndefinedC

Added in v1.0.0

void (export)

Signature

VoidC

Added in v1.0.0