Codec <T>

Hierarchy

• Codec
  • Module

Index

Codec

• __decode__
• __encode__
• __schema__

Codec

__decode__

• __decode__(this, input, context): Result<T, CodecError>

• Returns the decoded input, Result.Ok or Result.Error()

  interface SomeObject {
    foo: string
  }
  const someCodec: Codec<SomeObject> = ...;
  const input: unknown = ...;
  const decoded = Codec.decode(someCodec, input);

__encode__

• __encode__(this, input): unknown

• Returns the encoded input

  interface SomeObject {
    foo: string
  }
  const someCodec: Codec<SomeObject> = ...;
  const someObject: SomeObject = { foo: "bar" }
  const encoded = Codec.decode(someCodec, someObject);

__schema__

• __schema__(this): JSONValue

• Returns the JSONSchema corresponding to the decoded type

  const someCodec: Codec<unknown> = ...;
  const jsonSchema = Codec.schema(someCodec);