Class Storage

Hierarchy

Storage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Storage(): Storage

Returns Storage

Properties

nodeId

nodeId: string

storageFramework

storageFramework: {} = {}

Type declaration

[key: string]: IStorage

Private storageRefs

storageRefs: {} = {}

Type declaration

[key: string]: IStorageRef

Static NAME

NAME: string = 'Storage'

Methods

forClass

forClass<X>(classRef: string | Function | IClassRef): X

- Defined in src/libs/storage/Storage.ts:125
Returns storage ref for the given classRef or machineName

Type parameters
- X: IStorageRef
Parameters
- classRef: string | Function | IClassRef
Returns X

get

get<X>(name?: string): X

- Defined in src/libs/storage/Storage.ts:135
Type parameters
- X: IStorageRef
Parameters
- name: string = 'default'
Returns X

getAllOptions

getAllOptions(): IStorageOptions[]

- Defined in src/libs/storage/Storage.ts:149
Returns IStorageOptions[]

getDefaultFramework

getDefaultFramework(): any

- Defined in src/libs/storage/Storage.ts:27
return the name of the default framework to use

Returns any

getNames

getNames(): string[]

- Defined in src/libs/storage/Storage.ts:144
Returns string[]

getRefs

getRefs(): IStorageRef[]

- Defined in src/libs/storage/Storage.ts:139
Returns IStorageRef[]

prepare

prepare(config: {}, loader?: IRuntimeLoader): Promise<void>

- Defined in src/libs/storage/Storage.ts:53
Parameters
- config: {}
  - [name: string]: IStorageOptions
- Optional loader: IRuntimeLoader
Returns Promise<void>

register

register(name: string, options: IStorageOptions): Promise<IStorageRef>

- Defined in src/libs/storage/Storage.ts:32
Parameters
- name: string
- options: IStorageOptions
Returns Promise<IStorageRef>

registerFramework

registerFramework<T>(cls: Function | ClassType<T>, loader?: IRuntimeLoader): Promise<T>

- Defined in src/libs/storage/Storage.ts:43
Type parameters
- T: IStorage
Parameters
- cls: Function | ClassType<T>
- Optional loader: IRuntimeLoader
Returns Promise<T>

shutdown

shutdown(): Promise<void[]>

- Defined in src/libs/storage/Storage.ts:153
Returns Promise<void[]>

Generated using TypeDoc