StorageInterface

The StorageInterface interface represents the interface of a store.

Properties

actors

actors: string[] | Map<string, any>

Source

ecmascript/src/storage.ts:60

---

components

components: Components | Map<string, any>

Source

ecmascript/src/storage.ts:62

---

componentsIndex

componentsIndex: ComponentsIndex<string, string>

Source

ecmascript/src/storage.ts:69

---

entities

entities: string[] | Map<string, any>

Source

ecmascript/src/storage.ts:61

---

indexes

indexes: Object

Index signature

[key: string]: Object

Source

ecmascript/src/storage.ts:70

---

inputs

inputs: Inputs

Source

ecmascript/src/storage.ts:64

---

typeCtors

typeCtors: Object

Index signature

[key: string]: Function

Source

ecmascript/src/storage.ts:67

---

types

types: Object

Index signature

[key: string]: any

Source

ecmascript/src/storage.ts:66

Methods

destroyActor()

destroyActor(id): boolean | Promise<boolean>

Parameters

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:79

---

destroyComponent()

destroyComponent(id, key): void | Promise<void>

Parameters

• id: string

• key: string

Returns

void | Promise<void>

Source

ecmascript/src/storage.ts:80

---

destroyEntity()

destroyEntity(id): boolean | Promise<boolean>

Parameters

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:81

---

destroyId()

destroyId(list, id): boolean | Promise<boolean>

Parameters

• list: any

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:82

---

findComponent()

findComponent(id, key): any

Parameters

• id: string

• key: string

Returns

any

Source

ecmascript/src/storage.ts:85

---

findComponents()

findComponents(id): Components | Promise<Components>

Parameters

• id: string

Returns

Components | Promise<Components>

Source

ecmascript/src/storage.ts:84

---

findInput()

findInput(id, index): InputPayload | Promise<InputPayload>

Parameters

• id: string

• index: number

Returns

InputPayload | Promise<InputPayload>

Source

ecmascript/src/storage.ts:88

---

findInputs()

findInputs(id): Inputs | Promise<Inputs>

Parameters

• id: string

Returns

Inputs | Promise<Inputs>

Source

ecmascript/src/storage.ts:87

---

getActors()

getActors(): string[] | Emitter<string[]>

Returns

string[] | Emitter<string[]>

Source

ecmascript/src/storage.ts:90

---

getComponents()

getComponents(): Components | Emitter<Components>

Returns

Components | Emitter<Components>

Source

ecmascript/src/storage.ts:91

---

getEntities()

getEntities(): string[] | Emitter<string[]>

Returns

string[] | Emitter<string[]>

Source

ecmascript/src/storage.ts:92

---

getInputs()

getInputs(): Inputs | Emitter<Inputs>

Returns

Inputs | Emitter<Inputs>

Source

ecmascript/src/storage.ts:94

---

isActor()

isActor(id): boolean

Parameters

• id: string

Returns

boolean

Source

ecmascript/src/storage.ts:96

---

isEntity()

isEntity(id): boolean

Parameters

• id: string

Returns

boolean

Source

ecmascript/src/storage.ts:97

---

listActors()

listActors(query, pageSize): string[][] | Emitter<string[][]>

Parameters

• query: any

• pageSize: number

Returns

string[][] | Emitter<string[][]>

Source

ecmascript/src/storage.ts:99

---

listComponents()

listComponents(query, pageSize): Components[] | Emitter<Components[]>

Parameters

• query: any

• pageSize: number

Returns

Components[] | Emitter<Components[]>

Source

ecmascript/src/storage.ts:100

---

listEntities()

listEntities(query, pageSize): string[][] | Emitter<string[][]>

Parameters

• query: any

• pageSize: number

Returns

string[][] | Emitter<string[][]>

Source

ecmascript/src/storage.ts:101

---

listInputs()

listInputs(query, pageSize): Inputs[] | Emitter<Inputs[]>

Parameters

• query: any

• pageSize: number

Returns

Inputs[] | Emitter<Inputs[]>

Source

ecmascript/src/storage.ts:103

---

queryComponents()

queryComponents(query): Set<any> | Promise<Set<any>>

Parameters

• query: any

Returns

Set<any> | Promise<Set<any>>

Source

ecmascript/src/storage.ts:118

---

removeComponentsIndex()

removeComponentsIndex(id, key, prevValue): void | Promise<void>

Parameters

• id: string

• key: string

• prevValue: any

Returns

void | Promise<void>

Source

ecmascript/src/storage.ts:119

---

setActors()

setActors(actors): string[] | Promise<string[]>

Parameters

• actors: string[]

Returns

string[] | Promise<string[]>

Source

ecmascript/src/storage.ts:105

---

setComponents()

setComponents(components): Components | Promise<Components>

Parameters

• components: Components

Returns

Components | Promise<Components>

Source

ecmascript/src/storage.ts:106

---

setEntities()

setEntities(entities): string[] | Promise<string[]>

Parameters

• entities: any

Returns

string[] | Promise<string[]>

Source

ecmascript/src/storage.ts:107

---

setInputs()

setInputs(inputs): Inputs | Promise<Inputs>

Parameters

• inputs: any

Returns

Inputs | Promise<Inputs>

Source

ecmascript/src/storage.ts:109

---

storeActor()

storeActor(id): boolean | Promise<boolean>

Parameters

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:111

---

storeComponent()

storeComponent(id, key, value): void | Promise<void>

Parameters

• id: string

• key: string

• value: any

Returns

void | Promise<void>

Source

ecmascript/src/storage.ts:112

---

storeEntity()

storeEntity(id): boolean | Promise<boolean>

Parameters

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:113

---

storeId()

storeId(list, id): boolean | Promise<boolean>

Parameters

• list: any

• id: string

Returns

boolean | Promise<boolean>

Source

ecmascript/src/storage.ts:114

---

storeInput()

storeInput(id, input, tick): number | Promise<number>

Parameters

• id: string

• input: any

• tick: number

Returns

number | Promise<number>

Source

ecmascript/src/storage.ts:116

---

updateComponentsIndex()

updateComponentsIndex(id, key, prevValue, value): void | Promise<void>

Parameters

• id: string

• key: string

• prevValue: any

• value: any

Returns

void | Promise<void>

Source

ecmascript/src/storage.ts:120

---

Generated using typedoc-plugin-markdown and TypeDoc