@xylabs/creatable

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/creatable

*

Classes

- AbstractCreatable
- AbstractCreatableWithFactory
- Factory

Interfaces

- CreatableFactory
- Creatable
- CreatableWithFactory
- CreatableInstance
- CreatableParams
- CreatableStatusReporter
- Labels
- WithLabels
- WithOptionalLabels

Type Aliases

- CreatableName
- CreatableStatus

Functions

- creatable
- creatableFactory
- hasAllLabels

$3

### AbstractCreatable

@xylabs/creatable

*

Extends

- BaseEmitter\<Partial\<TParams\>, TEventData\>

Extended by

- AbstractCreatableWithFactory

Type Parameters

$3

TParams extends CreatableParams = CreatableParams

$3

TEventData extends EventData = EventData

Constructors

$3

``ts
new AbstractCreatable(key, params): AbstractCreatable;
`

$3

#### key

unknown

#### params

Partial\<TParams\>

$3

AbstractCreatable\<TParams, TEventData\>

$3

`ts
BaseEmitter, TEventData>.constructor
`

Properties

$3

`ts
static optional defaultLogger: Logger;
`

$3

`ts
BaseEmitter.defaultLogger
`

*

$3

`ts
readonly static globalInstances: Record[]>;
`

$3

`ts
BaseEmitter.globalInstances
`

*

$3

`ts
readonly static globalInstancesCountHistory: Record;
`

$3

`ts
BaseEmitter.globalInstancesCountHistory
`

*

$3

`ts
readonly static uniqueName: string;
`

$3

`ts
BaseEmitter.uniqueName
`

*

$3

`ts
optional defaultLogger: Logger;
`

*

$3

`ts
eventData: TEventData;
`

$3

`ts
BaseEmitter.eventData
`

Accessors

$3

$3

`ts
get static historyInterval(): number;
`

#### Returns

number

$3

`ts
set static historyInterval(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
BaseEmitter.historyInterval
`

*

$3

$3

`ts
get static historyTime(): number;
`

#### Returns

number

$3

`ts
set static historyTime(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
BaseEmitter.historyTime
`

*

$3

$3

`ts
get static maxGcFrequency(): number;
`

#### Returns

number

$3

`ts
set static maxGcFrequency(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

`ts
BaseEmitter.maxGcFrequency
`

*

$3

$3

`ts
get static maxHistoryDepth(): number;
`

#### Returns

number

$3

`ts
BaseEmitter.maxHistoryDepth
`

*

$3

$3

`ts
get logger(): undefined | Logger;
`

#### Returns

undefined \| Logger

$3

`ts
BaseEmitter.logger
`

*

$3

$3

`ts
get meter(): undefined | Meter;
`

#### Returns

undefined \| Meter

$3

`ts
BaseEmitter.meter
`

*

$3

$3

`ts
get tracer(): undefined | Tracer;
`

#### Returns

undefined \| Tracer

$3

`ts
BaseEmitter.tracer
`

*

$3

$3

`ts
get name(): string;
`

#### Returns

string

*

$3

$3

`ts
get params(): TParams;
`

#### Returns

TParams

$3

`ts
BaseEmitter.params
`

*

$3

$3

`ts
get statusReporter():
| undefined
| CreatableStatusReporter;
`

#### Returns

\| undefined
\| CreatableStatusReporter\<void\>

Methods

$3

$3

`ts
static gc(force?): void;
`

#### Parameters

##### force?

boolean

#### Returns

void

#### Inherited from

`ts
BaseEmitter.gc
`

$3

`ts
static gc(className): void;
`

#### Parameters

##### className

string

#### Returns

void

#### Inherited from

`ts
BaseEmitter.gc
`

*

$3

`ts
static instanceCount(className): number;
`

$3

#### className

string

$3

number

$3

`ts
BaseEmitter.instanceCount
`

*

$3

`ts
static instanceCounts(): Record;
`

$3

Record\<BaseClassName, number\>

$3

`ts
BaseEmitter.instanceCounts
`

*

$3

`ts
static startHistory(): void;
`

$3

void

$3

`ts
BaseEmitter.startHistory
`

*

$3

`ts
static stopHistory(): void;
`

$3

void

$3

`ts
BaseEmitter.stopHistory
`

*

$3

`ts
static create(this, inParams): Promise;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### inParams

Partial\<T\["params"\]\> = {}

$3

Promise\<T\>

*

$3

`ts
static createHandler(this, instance): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### instance

T

$3

Promisable\<T\>

*

$3

`ts
static paramsHandler(this, params): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params

Partial\<T\["params"\]\> = {}

$3

Promisable\<T\["params"\]\>

*

$3

`ts
createHandler(): Promisable;
`

$3

Promisable\<void\>

*

$3

`ts
paramsValidator(params): TParams;
`

$3

#### params

Partial\<TParams\>

$3

TParams

*

$3

`ts
start(): Promise;
`

$3

Promise\<boolean\>

*

$3

`ts
stop(): Promise;
`

$3

Promise\<boolean\>

*

$3

`ts
protected _noOverride(functionName): void;
`

$3

#### functionName

string = ...

$3

void

*

$3

`ts
protected startHandler(): Promisable;
`

$3

Promisable\<void\>

*

$3

`ts
protected stopHandler(): Promisable;
`

$3

Promisable\<void\>

*

$3

`ts
clearListeners(eventNames): this;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

this

$3

`ts
BaseEmitter.clearListeners
`

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

`ts
BaseEmitter.emit
`

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

`ts
BaseEmitter.emitSerial
`

*

$3

`ts
listenerCount(eventNames): number;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

number

$3

`ts
BaseEmitter.listenerCount
`

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

void

$3

`ts
BaseEmitter.off
`

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

EventAnyListener

$3

void

$3

`ts
BaseEmitter.offAny
`

*

$3

`ts
on(eventNames, listener): () => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(): void;
`

#### Returns

void

$3

`ts
BaseEmitter.on
`

*

$3

`ts
onAny(listener): () => void;
`

$3

#### listener

EventAnyListener

$3

`ts
(): void;
`

#### Returns

void

$3

`ts
BaseEmitter.onAny
`

*

$3

`ts
once(eventName, listener): () => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(): void;
`

#### Returns

void

$3

`ts
BaseEmitter.once
`

### AbstractCreatableWithFactory

@xylabs/creatable

*

Extends

- AbstractCreatable\<TParams, TEventData\>

Type Parameters

$3

TParams extends CreatableParams = CreatableParams

$3

TEventData extends EventData = EventData

Constructors

$3

`ts
new AbstractCreatableWithFactory(key, params): AbstractCreatableWithFactory;
`

$3

#### key

unknown

#### params

Partial\<TParams\>

$3

AbstractCreatableWithFactory\<TParams, TEventData\>

$3

AbstractCreatable.constructor

Properties

$3

`ts
static optional defaultLogger: Logger;
`

$3

AbstractCreatable.defaultLogger

*

$3

`ts
readonly static globalInstances: Record[]>;
`

$3

AbstractCreatable.globalInstances

*

$3

`ts
readonly static globalInstancesCountHistory: Record;
`

$3

AbstractCreatable.globalInstancesCountHistory

*

$3

`ts
readonly static uniqueName: string;
`

$3

AbstractCreatable.uniqueName

*

$3

`ts
optional defaultLogger: Logger;
`

$3

AbstractCreatable.defaultLogger

*

$3

`ts
eventData: TEventData;
`

$3

AbstractCreatable.eventData

Accessors

$3

$3

`ts
get static historyInterval(): number;
`

#### Returns

number

$3

`ts
set static historyInterval(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

AbstractCreatable.historyInterval

*

$3

$3

`ts
get static historyTime(): number;
`

#### Returns

number

$3

`ts
set static historyTime(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

AbstractCreatable.historyTime

*

$3

$3

`ts
get static maxGcFrequency(): number;
`

#### Returns

number

$3

`ts
set static maxGcFrequency(value): void;
`

#### Parameters

##### value

number

#### Returns

void

$3

AbstractCreatable.maxGcFrequency

*

$3

$3

`ts
get static maxHistoryDepth(): number;
`

#### Returns

number

$3

AbstractCreatable.maxHistoryDepth

*

$3

$3

`ts
get logger(): undefined | Logger;
`

#### Returns

undefined \| Logger

$3

AbstractCreatable.logger

*

$3

$3

`ts
get meter(): undefined | Meter;
`

#### Returns

undefined \| Meter

$3

AbstractCreatable.meter

*

$3

$3

`ts
get tracer(): undefined | Tracer;
`

#### Returns

undefined \| Tracer

$3

AbstractCreatable.tracer

*

$3

$3

`ts
get name(): string;
`

#### Returns

string

$3

AbstractCreatable.name

*

$3

$3

`ts
get params(): TParams;
`

#### Returns

TParams

$3

AbstractCreatable.params

*

$3

$3

`ts
get statusReporter():
| undefined
| CreatableStatusReporter;
`

#### Returns

\| undefined
\| CreatableStatusReporter\<void\>

$3

AbstractCreatable.statusReporter

Methods

$3

$3

`ts
static gc(force?): void;
`

#### Parameters

##### force?

boolean

#### Returns

void

#### Inherited from

AbstractCreatable.gc

$3

`ts
static gc(className): void;
`

#### Parameters

##### className

string

#### Returns

void

#### Inherited from

AbstractCreatable.gc

*

$3

`ts
static instanceCount(className): number;
`

$3

#### className

string

$3

number

$3

AbstractCreatable.instanceCount

*

$3

`ts
static instanceCounts(): Record;
`

$3

Record\<BaseClassName, number\>

$3

AbstractCreatable.instanceCounts

*

$3

`ts
static startHistory(): void;
`

$3

void

$3

AbstractCreatable.startHistory

*

$3

`ts
static stopHistory(): void;
`

$3

void

$3

AbstractCreatable.stopHistory

*

$3

`ts
static create(this, inParams): Promise;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### inParams

Partial\<T\["params"\]\> = {}

$3

Promise\<T\>

$3

AbstractCreatable.create

*

$3

`ts
static createHandler(this, instance): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### instance

T

$3

Promisable\<T\>

$3

AbstractCreatable.createHandler

*

$3

`ts
static paramsHandler(this, params): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params

Partial\<T\["params"\]\> = {}

$3

Promisable\<T\["params"\]\>

$3

AbstractCreatable.paramsHandler

*

$3

`ts
createHandler(): Promisable;
`

$3

Promisable\<void\>

$3

AbstractCreatable.createHandler

*

$3

`ts
paramsValidator(params): TParams;
`

$3

#### params

Partial\<TParams\>

$3

TParams

$3

AbstractCreatable.paramsValidator

*

$3

`ts
start(): Promise;
`

$3

Promise\<boolean\>

$3

AbstractCreatable.start

*

$3

`ts
stop(): Promise;
`

$3

Promise\<boolean\>

$3

AbstractCreatable.stop

*

$3

`ts
protected _noOverride(functionName): void;
`

$3

#### functionName

string = ...

$3

void

$3

AbstractCreatable._noOverride

*

$3

`ts
protected startHandler(): Promisable;
`

$3

Promisable\<void\>

$3

AbstractCreatable.startHandler

*

$3

`ts
protected stopHandler(): Promisable;
`

$3

Promisable\<void\>

$3

AbstractCreatable.stopHandler

*

$3

`ts
static factory(
this,
params?,
labels?): CreatableFactory;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

#### labels?

Labels

$3

CreatableFactory\<T\>

*

$3

`ts
clearListeners(eventNames): this;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

this

$3

AbstractCreatable.clearListeners

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

AbstractCreatable.emit

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol = keyof TEventData

#### TEventArgs

TEventArgs extends EventArgs = TEventData\[TEventName\]

$3

#### eventName

TEventName

#### eventArgs

TEventArgs

$3

Promise\<void\>

$3

AbstractCreatable.emitSerial

*

$3

`ts
listenerCount(eventNames): number;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

number

$3

AbstractCreatable.listenerCount

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

void

$3

AbstractCreatable.off

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

EventAnyListener

$3

void

$3

AbstractCreatable.offAny

*

$3

`ts
on(eventNames, listener): () => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(): void;
`

#### Returns

void

$3

AbstractCreatable.on

*

$3

`ts
onAny(listener): () => void;
`

$3

#### listener

EventAnyListener

$3

`ts
(): void;
`

#### Returns

void

$3

AbstractCreatable.onAny

*

$3

`ts
once(eventName, listener): () => void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

`ts
(): void;
`

#### Returns

void

$3

AbstractCreatable.once

### Factory

@xylabs/creatable

*

Type Parameters

$3

T extends CreatableInstance = CreatableInstance

Implements

- CreatableFactory\<T\>

Constructors

$3

`ts
new Factory(
creatable,
params?,
labels?): Factory;
`

$3

#### creatable

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

#### labels?

Labels = {}

$3

Factory\<T\>

Properties

$3

`ts
creatable: Creatable;
`

*

$3

`ts
optional defaultParams: Partial;
`

*

$3

`ts
optional labels: Labels;
`

Methods

$3

`ts
static withParams(
creatableModule,
params?,
labels?): Factory;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### creatableModule

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

#### labels?

Labels = {}

$3

Factory\<T\>

*

$3

`ts
create(params?): Promise;
`

$3

#### params?

Partial\<T\["params"\]\>

$3

Promise\<T\>

$3

CreatableFactory.create

$3

### creatable

@xylabs/creatable

*

`ts
function creatable(): (constructor) => void;
`

Class annotation to be used to decorate Modules which support
an asynchronous creation pattern

Type Parameters

$3

T extends CreatableInstance\<CreatableParams, EventData\>

Returns

The decorated Module requiring it implement the members
of the CreatableModule as statics properties/methods

`ts
(constructor): void;
`

$3

$3

U extends Creatable\<T\>

$3

$3

U

$3

void

### creatableFactory

@xylabs/creatable

*

`ts
function creatableFactory(): (constructor) => void;
`

Class annotation to be used to decorate Modules which support
an asynchronous creation factory pattern

Returns

The decorated Module requiring it implement the members
of the CreatableModule as statics properties/methods

`ts
(constructor): void;
`

$3

$3

U extends CreatableFactory\<CreatableInstance\<CreatableParams, EventData\>\>

$3

$3

U

$3

void

### hasAllLabels

@xylabs/creatable

*

`ts
function hasAllLabels(source?, required?): boolean;
`

Returns true if the source object has all the labels from the required set

Parameters

$3

Labels

Source object to check against

$3

Labels

Set of labels to check for in source

Returns

boolean

True of the source object has all the labels from the required set

$3

### Creatable

@xylabs/creatable

*

Extended by

- CreatableWithFactory

Type Parameters

$3

T extends CreatableInstance = CreatableInstance

Constructors

$3

`ts
new Creatable(key, params): T & AbstractCreatable;
`

$3

#### key

unknown

#### params

Partial\<CreatableParams\>

$3

T & AbstractCreatable\<T\["params"\], EventData\>

Properties

$3

`ts
optional defaultLogger: Logger;
`

Methods

$3

`ts
create(this, params?): Promise;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

$3

Promise\<T\>

*

$3

`ts
createHandler(this, instance): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### instance

T

$3

Promisable\<T\>

*

$3

`ts
paramsHandler(this, params?): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

$3

Promisable\<T\["params"\]\>

### CreatableFactory

@xylabs/creatable

*

Extends

- Omit\<Creatable\<T\>,
\| "create"
\| "createHandler"
\| "paramsHandler"
\| "defaultLogger"
\| "factory"\>

Type Parameters

$3

T extends CreatableInstance = CreatableInstance

Methods

$3

`ts
create(this, params?): Promise;
`

$3

#### this

CreatableFactory\<T\>

#### params?

Partial\<T\["params"\]\>

$3

Promise\<T\>

### CreatableInstance

@xylabs/creatable

*

Extends

- EventEmitter\<TEventData\>

Type Parameters

$3

TParams extends CreatableParams = CreatableParams

$3

TEventData extends EventData = EventData

Properties

$3

`ts
eventData: TEventData;
`

$3

`ts
EventEmitter.eventData
`

*

$3

`ts
name: string;
`

*

$3

`ts
params: TParams;
`

Methods

$3

`ts
clearListeners(eventNames): void;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

void

$3

`ts
EventEmitter.clearListeners
`

*

$3

`ts
emit(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

TEventData\[TEventName\]

$3

Promise\<void\>

$3

`ts
EventEmitter.emit
`

*

$3

`ts
emitSerial(eventName, eventArgs): Promise;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### eventArgs

TEventData\[TEventName\]

$3

Promise\<void\>

$3

`ts
EventEmitter.emitSerial
`

*

$3

`ts
listenerCount(eventNames): number;
`

$3

#### eventNames

keyof TEventData | keyof TEventData[]

$3

number

$3

`ts
EventEmitter.listenerCount
`

*

$3

`ts
off(eventNames, listener): void;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

void

$3

`ts
EventEmitter.off
`

*

$3

`ts
offAny(listener): void;
`

$3

#### listener

Promise\<void\> | EventAnyListener

$3

void

$3

`ts
EventEmitter.offAny
`

*

$3

`ts
on(eventNames, listener): EventUnsubscribeFunction;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventNames

TEventName | TEventName[]

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

EventUnsubscribeFunction

$3

`ts
EventEmitter.on
`

*

$3

`ts
onAny(listener): EventUnsubscribeFunction;
`

$3

#### listener

EventAnyListener

$3

EventUnsubscribeFunction

$3

`ts
EventEmitter.onAny
`

*

$3

`ts
once(eventName, listener): EventUnsubscribeFunction;
`

$3

#### TEventName

TEventName extends string \| number \| symbol

$3

#### eventName

TEventName

#### listener

EventListener\<TEventData\[TEventName\]\>

$3

EventUnsubscribeFunction

$3

`ts
EventEmitter.once
`

### CreatableParams

@xylabs/creatable

*

Extends

- BaseEmitterParams

Properties

$3

`ts
optional logger: Logger;
`

$3

`ts
BaseEmitterParams.logger
`

*

$3

`ts
optional meterProvider: MeterProvider;
`

$3

`ts
BaseEmitterParams.meterProvider
`

*

$3

`ts
optional traceProvider: TracerProvider;
`

$3

`ts
BaseEmitterParams.traceProvider
`

*

$3

`ts
optional name: string;
`

*

$3

`ts
optional statusReporter: CreatableStatusReporter;
`

### CreatableStatusReporter

@xylabs/creatable

*

Type Parameters

$3

T extends void \| string = void

Methods

$3

$3

`ts
report(
name,
status,
progress?): void;
`

#### Parameters

##### name

string

##### status

Exclude\<T extends void ? CreatableStatus : T \| CreatableStatus, "error"\>

##### progress?

number

#### Returns

void

$3

`ts
report(
name,
status,
error?): void;
`

#### Parameters

##### name

string

##### status

Extract\<T extends void ? CreatableStatus : T \| CreatableStatus, "error"\>

##### error?

Error

#### Returns

void

### CreatableWithFactory

@xylabs/creatable

*

Extends

- Creatable\<T\>

Type Parameters

$3

T extends CreatableInstance = CreatableInstance

Constructors

$3

`ts
new CreatableWithFactory(key, params): T & AbstractCreatable;
`

$3

#### key

unknown

#### params

Partial\<CreatableParams\>

$3

T & AbstractCreatable\<T\["params"\], EventData\>

$3

Creatable.constructor

Properties

$3

`ts
optional defaultLogger: Logger;
`

$3

Creatable.defaultLogger

Methods

$3

`ts
create(this, params?): Promise;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

$3

Promise\<T\>

$3

Creatable.create

*

$3

`ts
createHandler(this, instance): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### instance

T

$3

Promisable\<T\>

$3

Creatable.createHandler

*

$3

`ts
paramsHandler(this, params?): Promisable;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

$3

Promisable\<T\["params"\]\>

$3

Creatable.paramsHandler

*

$3

`ts
factory(
this,
params?,
labels?): CreatableFactory;
`

$3

#### T

T extends CreatableInstance\<CreatableParams, EventData\>

$3

#### this

Creatable\<T\>

#### params?

Partial\<T\["params"\]\>

#### labels?

Labels

$3

CreatableFactory\<T\>

### Labels

@xylabs/creatable

*

Object used to represent labels identifying a resource.

Indexable

`ts
[key: string]: undefined | string
`

### WithLabels

@xylabs/creatable

*

Interface for objects that have labels.

Type Parameters

$3

T extends Labels = Labels

Properties

$3

`ts
labels: T;
`

### WithOptionalLabels

@xylabs/creatable

*

Interface for objects that have labels.

Type Parameters

$3

T extends Labels = Labels

Properties

$3

`ts
optional labels: T;
`

$3

### CreatableName

@xylabs/creatable

*

`ts
type CreatableName = Exclude & BaseClassName;
`

### CreatableStatus

@xylabs/creatable

*

`ts
type CreatableStatus =
| "creating"
| "created"
| "starting"
| "started"
| "stopping"
| "stopped"
| "error";
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/creatable.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/creatable
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/creatable
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/creatable

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/creatable/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/creatable

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/creatable
[socket-link]: https://socket.dev/npm/package/@xylabs/creatable