Struct

Index

Constructor

• Module

Other

• DefineParameters
• ModuleParameter
• Parameters
• type
• type
• create
• define

Constructor

Module

• Module(properties): Model

• Construct a new model

inherited__call__

__call__: (properties) => Model

Inherited from Callable.__call__

Callable property

inherited__inspect__

__inspect__: Option<(anyValue, depth, options, inspect) => string>

Inherited from Module.__inspect__

When defined, returns a custom string representation. To be useful, it should be bound to a prototype (ex: Struct)

import { inspect } from 'node:util';

interface Foo {
  foo: boolean;
}
const Foo = Struct.define<Foo>({
  typeName: 'Foo',
  __inspect__: (self) => `Foo { ${String(self.foo)} }`,
});
const myStruct = Struct.create(Foo, { foo: true });// 'Foo { true }'
inspect(myStruct);// 'Foo { true }'

readonlytypeName

typeName: Model[_]

Overrides Module.typeName

The factory type constant

inherited__decode__

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

• Inherited from Module.__decode__

  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);

inherited__encode__

• __encode__(this, input): unknown

• Inherited from Module.__encode__

  Returns the encoded input

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

inherited__schema__

• __schema__(this): JSONValue

• Inherited from Module.__schema__

  Returns the JSONSchema corresponding to the decoded type

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

inheritedasInstance

• asInstance(this, anyValue): Option<Model>

• Inherited from Module.asInstance

  Try to convert anyValue to enum value or else returns Option.None

  const StringType: Type<string>;
  StringType.asInstance('foo'); // Option.Some('foo')
  StringType.asInstance(12); // Option.None

inheritedasString

• asString(this, self): string

• Inherited from Module.asString

  Converts the given value to a String.

  Number.asString(123); // '123'

create

• create(this, properties): Model

• Construct a new model

inheritedhasInstance

• hasInstance(this, anyValue): anyValue is Model

• Inherited from Module.hasInstance

  Return true if the given value is an instance of the class.

  const StringType: Type<string>;
  StringType.hasInstance('foo'); // true
  StringType.hasInstance(42); // false

Other

DefineParameters

DefineParameters<Model>:

Type parameters

• Model: Struct<{ _: string }>

optionalinherited__inspect__

__inspect__?: Option<(anyValue, depth, options, inspect) => string>

Inherited from PartialKeys.__inspect__

When defined, returns a custom string representation. To be useful, it should be bound to a prototype (ex: Struct)

import { inspect } from 'node:util';

interface Foo {
  foo: boolean;
}
const Foo = Struct.define<Foo>({
  typeName: 'Foo',
  __inspect__: (self) => `Foo { ${String(self.foo)} }`,
});
const myStruct = Struct.create(Foo, { foo: true });// 'Foo { true }'
inspect(myStruct);// 'Foo { true }'

optionalinheritedhasInstance

hasInstance?: (value) => boolean

Inherited from PartialKeys.hasInstance

typeName

typeName: Model[_]

Overrides PartialKeys.typeName

Type string representation

StringType.typeName // 'String'
Int.typeName // 'Int'
Person.typeName // 'Person'

optionalinherited__decode__

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

• Inherited from PartialKeys.__decode__

  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);

optionalinherited__encode__

• __encode__(this, input): unknown

• Inherited from PartialKeys.__encode__

  Returns the encoded input

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

optionalinherited__schema__

• __schema__(this): JSONValue

• Inherited from PartialKeys.__schema__

  Returns the JSONSchema corresponding to the decoded type

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

optionalinheritedasInstance

• asInstance(this, anyValue): Option<Model>

• Inherited from PartialKeys.asInstance

  Try to convert anyValue to enum value or else returns Option.None

  const StringType: Type<string>;
  StringType.asInstance('foo'); // Option.Some('foo')
  StringType.asInstance(12); // Option.None

optionalinheritedasString

• asString(this, self): string

• Inherited from PartialKeys.asString

  Converts the given value to a String.

  Number.asString(123); // '123'

ModuleParameter

ModuleParameter<T>: Pick<Type<T>, Symbol.inspect> & AsString<T>

Type parameters

• T

Parameters

Parameters<Model>: Omit<Model, Struct.type>

Extract all parameters to create a new Struct

---

Type parameters

• Model

type

type: typeof type

type

type: _

The type property discriminator

create

• create<Properties>(module, properties): Properties

• Return a new Struct from properties. Struct adds debugging / inspecting abilities

  const SomeType = Type.define<{ some: boolean }>({ typeName: 'SomeType' });
  
  Struct.create(SomeType, { some: true });// Struct { _: 'SomeType', some: true }

define

• define<Model>(parameters): Module<Model>

• Return a new Struct default factory See Module for additional properties added to the constructor

  type Model = Struct<{ [Struct.type]: 'Model', foo: boolean }>
  const Model = Struct.define<Model>({ typeName: 'Model' });
  
  const instance = Model({ foo: true }); // { _: 'Model', foo: true }
  Model.typeName === 'Model' // true
  Model.hasInstance(instance); // true