Codec

Index

Interfaces

• Context

Type Aliases

• TypeOf

Functions

• decode
• encode
• lazy
• schema

Interfaces

Context

Context<T>:

Type parameters

• T

error

error: (input, asType) => Result<T, CodecError>

Helper that returns a new Error result

ok

ok: (value) => Result<T, CodecError>

Helper that returns a new Ok result

Type Aliases

TypeOf

TypeOf<V>: V extends Codec<infer Type> ? Type : never

Type parameters

• V

Functions

decode

• decode<T>(codec, input): Result<T, CodecError>

• Returns a Result containing the decoded input

  const codec: Codec<Date> = dateISO;
  const input = '2022-07-31T14:04:48.449Z';
  const decoded = Codec.decode(codec, input);// Result.Ok('2022-07-31T14:04:48.449Z')

encode

• encode<T>(codec, input): unknown

• Returns the encoded input

  const codec: Codec<Date> = dateISO;
  const input = new Date('2022-07-31T14:04:48.449Z');
  const encoded = Codec.encode(codec, input);// '2022-07-31T14:04:48.449Z'

lazy

• lazy<T>(getCodec): Codec<T>

• Returns a lazy evaluated codec. Useful for recursive structures.

  interface Node {
    value: unknown,
    children: Node[]
  }
  const Node = object<Node>({
    content: string,
    responses: Codec.lazy(() => array(Node))
  })

schema

• schema<T>(codec): JSONValue

• Returns the JSONSchema

  Codec.schema(string);// { type: 'string' }