Codec <T>

Hierarchy

• Codec
  • Enumerable
  • Module
  • Module

Index

Codec

• codecDecode
• codecEncode
• codecSchema

Codec

codecDecode

• codecDecode(this: void, input: unknown, context: Context<T>): Result<T, CodecError>

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

  @example

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

codecEncode

• codecEncode(this: void, input: T): unknown

• Returns the encoded input

  @example

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

codecSchema

• codecSchema(this: void): JSONValue

• Returns the JSONSchema corresponding to the decoded type

  @example

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