abstractContract <T>

Implements

• Optionable<T>

Index

Constructors

• constructor

Properties

• options

Methods

• blueprint
• configure

Constructors

constructor

• new Contract<T>(options?: T): Contract<T>

• Type parameters

  • T: object = {}

Properties

readonlyoptions

options: Readonly<Required<T>>

Implementation of Optionable.options

Validated and configured options.

Methods

abstractblueprint

• blueprint(_schemas: __module, onConstruction?: boolean): object

• Implementation of Optionable.blueprint

  Define an optimal blueprint in which to validate and build the options object passed to the constructor, or when manual setting.

  A boolean is passed as the 2nd argument to determine whether this is validating on class instantiation (first time), or by calling configure() (all other times).

configure

• configure(options?: Partial<T> | (options: Required<T>) => Partial<T>): Readonly<Required<T>>

• Set an options object by merging the new partial and existing options with the defined blueprint, while running all validation checks. Freeze and return the options object.

  object.configure({ name: 'Boost' });
  
  object.configure((prevOptions) => ({
      nestedObject: {
          ...prevOptions.nestedObject,
          some: 'value',
      },
  }));