EntityEncoderComponent<Decoded, Encoded>
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
Decoded extends any | any |
Encoded extends { } | { } |
Constructors
Constructor
new EntityEncoderComponent<Decoded, Encoded>(options?): EntityEncoderComponent<Decoded, Encoded>;
Parameters
| Parameter | Type |
|---|---|
options | EntityEncoderComponentOptions |
Returns
EntityEncoderComponent<Decoded, Encoded>
Overrides
EntityDefinitionComponent.constructor
Properties
| Property | Modifier | Type | Default value | Inherited from |
|---|---|---|---|---|
definition | public | EntityDefinition | undefined | EntityDefinitionComponent.definition |
type | public | string | undefined | EntityDefinitionComponent.type |
TYPE | static | string | 'encoder' | - |
Accessors
system
Get Signature
get system(): System;
Returns
Inherited from
EntityDefinitionComponent.system
version
Get Signature
get version(): number;
Returns
number
Methods
decode()
decode(entity): Promise<Decoded>;
Parameters
| Parameter | Type |
|---|---|
entity | EncodedEntity<Encoded> |
Returns
Promise<Decoded>
encode()
encode(entity): EncodedEntity<Encoded>;
Parameters
| Parameter | Type |
|---|---|
entity | Decoded |
Returns
EncodedEntity<Encoded>
setDefinition()
setDefinition(definition): void;
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
Returns
void