Tag

Index

Interfaces

• Module
• Parameters

Functions

• define

Interfaces

Module

• Module(value): To

• Convert an underlying type to a tagged type Alias to wrap(value)

typeName

Re-exports typeName

inherited__call__

__call__: (value) => To

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)

@example

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 }'

@param

inherited__decode__

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

• Inherited from Module.__decode__

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

inherited__encode__

• __encode__(this, input): unknown

• Inherited from Module.__encode__

  Returns the encoded input

  @example

  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

  @example

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

inheritedasInstance

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

• Inherited from Module.asInstance

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

  @example

  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.

  @example

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

inheritedhasInstance

• hasInstance(this, anyValue): anyValue is To

• Inherited from Module.hasInstance

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

  @example

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

unwrap

• unwrap(value): From

• Convert a tagged value to the underlying type

wrap

• wrap(value): To

• Convert an underlying type to a tagged type

Parameters

Parameters<T>:

Type module constructor parameters

---

Type parameters

• T

optionalinherited__inspect__

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

Inherited from Parameters.__inspect__

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

@example

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 }'

@param

inheritedhasInstance

hasInstance: (value) => boolean

Inherited from Parameters.hasInstance

inheritedtypeName

typeName: string

Inherited from Parameters.typeName

Type string representation

@example

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

optionalinherited__decode__

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

• Inherited from Parameters.__decode__

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

optionalinherited__encode__

• __encode__(this, input): unknown

• Inherited from Parameters.__encode__

  Returns the encoded input

  @example

  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 Parameters.__schema__

  Returns the JSONSchema corresponding to the decoded type

  @example

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

optionalinheritedasInstance

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

• Inherited from Parameters.asInstance

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

  @example

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

optionalinheritedasString

• asString(this, self): string

• Inherited from Parameters.asString

  Converts the given value to a String.

  @example

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

Functions

define

• define<From, To>(parameters): Tag.Module<From, To>

• Returns a new Tag module

  @example

  type Foo = string & Tag<'Foo'>;
  const Foo = Tag.define<string, Foo>({
    typeName: 'Foo',
    hasInstance: (anyValue) => typeof anyValue === 'string',
  });