Type <T>

A type that represents a class module of T instances

Hierarchy

• Type
  • Enumerable
  • Module
  • Module
  • Module

Index

Constructor

• asInstance

Type

• inspect
• hasInstance

Other

• typeName

Constructor

asInstance

• asInstance(anyValue: unknown): Option<T>

• 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

Type

inspect

inspect: Option<(anyValue: T, depth: number, options: InspectOptions, inspect: InspectFunction) => string>

When defined, returns a custom string representation

@example

@param

hasInstance

• hasInstance(anyValue: unknown): anyValue is T

• 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

Other

typeName

Re-exports typeName