Skip to content

Type.TypeAlias.Customiser

DecentM edited this page Jan 16, 2026 · 26 revisions

@decentm/concourse-ts / Type / Customiser

Type Alias: Customiser<Type, Options>

Customiser<Type, Options>: Options extends void ? (instance) => void : (instance, parent) => void

Defined in: declarations/customiser.ts:15

A customiser is a function that concourse-ts calls during an object's construction. Customiser functions are provided by the user either by calling a static method called customise, or by calling a method called customise on the class instance itself.

For example, this snippet will set a default name on all DoSteps:

DoStep.customise((do_step) => {
  do_step.name = 'my-step'
})

Type Parameters

Type

Options = void

Clone this wiki locally