Link Search Menu Expand Document

Encoder overview

This module is experimental

Experimental features are published in order to get early feedback from the community, see these tracking issues for further discussions and enhancements.

A feature tagged as Experimental is in a high state of flux, you’re at risk of it changing without notice.

Added in v2.2.3


Table of contents


Category

id

Signature

export declare function id<A>(): Encoder<A, A>

Added in v2.2.3

Contravariant

contramap

Signature

export declare const contramap: <A, B>(f: (b: B) => A) => <E>(fa: Encoder<E, A>) => Encoder<E, B>

Added in v2.2.3

Semigroupoid

compose

Signature

export declare const compose: <E, A>(ea: Encoder<E, A>) => <B>(ab: Encoder<A, B>) => Encoder<E, B>

Added in v2.2.3

combinators

array

Signature

export declare function array<O, A>(item: Encoder<O, A>): Encoder<Array<O>, Array<A>>

Added in v2.2.3

intersect

Signature

export declare const intersect: <P, B>(right: Encoder<P, B>) => <O, A>(left: Encoder<O, A>) => Encoder<O & P, A & B>

Added in v2.2.3

lazy

Signature

export declare function lazy<O, A>(f: () => Encoder<O, A>): Encoder<O, A>

Added in v2.2.3

nullable

Signature

export declare function nullable<O, A>(or: Encoder<O, A>): Encoder<null | O, null | A>

Added in v2.2.3

partial

Signature

export declare function partial<P extends Record<string, Encoder<any, any>>>(
  properties: P
): Encoder<Partial<{ [K in keyof P]: OutputOf<P[K]> }>, Partial<{ [K in keyof P]: TypeOf<P[K]> }>>

Added in v2.2.3

readonly

Signature

export declare const readonly: <O, A>(decoder: Encoder<O, A>) => Encoder<O, Readonly<A>>

Added in v2.2.16

record

Signature

export declare function record<O, A>(codomain: Encoder<O, A>): Encoder<Record<string, O>, Record<string, A>>

Added in v2.2.3

struct

Signature

export declare function struct<P extends Record<string, Encoder<any, any>>>(
  properties: P
): Encoder<{ [K in keyof P]: OutputOf<P[K]> }, { [K in keyof P]: TypeOf<P[K]> }>

Added in v2.2.15

sum

Signature

export declare function sum<T extends string>(
  tag: T
): <MS extends Record<string, Encoder<any, any>>>(members: MS) => Encoder<OutputOf<MS[keyof MS]>, TypeOf<MS[keyof MS]>>

Added in v2.2.3

tuple

Signature

export declare function tuple<C extends ReadonlyArray<Encoder<any, any>>>(
  ...components: C
): Encoder<{ [K in keyof C]: OutputOf<C[K]> }, { [K in keyof C]: TypeOf<C[K]> }>

Added in v2.2.3

type

Use struct instead.

Signature

export declare const type: typeof struct

Added in v2.2.3

instances

Category

Signature

export declare const Category: Category2<'io-ts/Encoder'>

Added in v2.2.8

Contravariant

Signature

export declare const Contravariant: Contravariant2<'io-ts/Encoder'>

Added in v2.2.8

URI

Signature

export declare const URI: 'io-ts/Encoder'

Added in v2.2.3

URI (type alias)

Signature

export type URI = typeof URI

Added in v2.2.3

model

Encoder (interface)

Signature

export interface Encoder<O, A> {
  readonly encode: (a: A) => O
}

Added in v2.2.3

utils

OutputOf (type alias)

Signature

export type OutputOf<E> = E extends Encoder<infer O, any> ? O : never

Added in v2.2.3

TypeOf (type alias)

Signature

export type TypeOf<E> = E extends Encoder<any, infer A> ? A : never

Added in v2.2.3