Skip to main content

EntityEncoderBank<T>

Extends

Type Parameters

Type ParameterDefault type
Tany

Constructors

Constructor

new EntityEncoderBank<T>(options): EntityEncoderBank<T>;

Parameters

ParameterType
optionsEntityEncoderBankOptions

Returns

EntityEncoderBank<T>

Overrides

ComponentBank.constructor

Methods

decode()

decode(entity): Promise<T>;

Parameters

ParameterType
entityEncodedEntity

Returns

Promise<T>


encode()

encode(entity, throws?): EncodedEntity<{
}>;

Parameters

ParameterTypeDefault value
entityTundefined
throwsbooleantrue

Returns

EncodedEntity<{ }>


find()

find(predicate): EntityEncoderComponent<T, {
}>;

Parameters

ParameterType
predicate(item) => boolean

Returns

EntityEncoderComponent<T, { }>

Inherited from

ComponentBank.find


getEncoder()

getEncoder(version?): EntityEncoderComponent<T>;

Parameters

ParameterType
version?number

Returns

EntityEncoderComponent<T>


getFirst()

getFirst(): EntityEncoderComponent<T, {
}>;

Returns

EntityEncoderComponent<T, { }>

Inherited from

ComponentBank.getFirst


getItems()

getItems(): EntityEncoderComponent<T, {
}>[];

Returns

EntityEncoderComponent<T, { }>[]

Inherited from

ComponentBank.getItems


register()

register(item): EntityEncoderComponent;

Parameters

ParameterType
itemEntityEncoderComponent

Returns

EntityEncoderComponent

Inherited from

ComponentBank.register