EntityDocsComponent<T>
Extends
Type Parameters
| Type Parameter |
|---|
T |
Constructors
Constructor
new EntityDocsComponent<T>(options): EntityDocsComponent<T>;
Parameters
| Parameter | Type |
|---|---|
options | EntityDocsComponentOptions<T> |
Returns
EntityDocsComponent<T>
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 | 'docs' | - |
Accessors
label
Get Signature
get label(): string;
Returns
string
system
Get Signature
get system(): System;
Returns
Inherited from
EntityDefinitionComponent.system
Methods
getDocs()
getDocs(entity): string;
Parameters
| Parameter | Type |
|---|---|
entity | T |
Returns
string
setDefinition()
setDefinition(definition): void;
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
Returns
void