Class Store

Store class which is used to store all the resources, tasks, middleware and events.

Index

Constructors

Properties

eventManager events middlewares resources root tasks

Accessors

Methods

checkIfIDExists checkLock dispose getDependentNodes getGlobalMiddlewares initializeStore lock storeEvent storeGenericItem

Constructors

constructor

new Store(eventManager): Store
Parameters
- eventManager: EventManager
Returns Store
- Defined in Store.ts:65

Properties

`Protected` `Readonly`eventManager

eventManager: EventManager

events

events: Map<string, EventStoreElementType> = ...

middlewares

middlewares: Map<string, MiddlewareStoreElementType<any>> = ...

resources

resources: Map<string, ResourceStoreElementType<any, any, {}>> = ...

root

root: ResourceStoreElementType<any, any, {}>

tasks

tasks: Map<string, TaskStoreElementType<any, any, any>> = ...

Accessors

isLocked

get isLocked(): boolean
Returns boolean
- Defined in Store.ts:67

Methods

`Protected`checkIfIDExists

checkIfIDExists(id): void
middlewares are already stored in their final form and the check for them would be redundant
Parameters
- id: string
Returns void
- Defined in Store.ts:145

checkLock

checkLock(): void
Returns void
- Defined in Store.ts:81

dispose

dispose(): Promise<void>
Returns Promise<void>
- Defined in Store.ts:157

getDependentNodes

getDependentNodes(): IDependentNode[]
Returns IDependentNode[]
- Defined in Store.ts:269

getGlobalMiddlewares

getGlobalMiddlewares(excludingIds): IMiddleware<any>[]
Parameters
- excludingIds: string[]
Returns IMiddleware<any>[]
- Defined in Store.ts:169

initializeStore

initializeStore(root, config): void
Store the root before beginning registration
Parameters
- root: IResource<any, any, any>
- config: any
Returns void
- Defined in Store.ts:92

lock

lock(): void
Returns void
- Defined in Store.ts:71

storeEvent

storeEvent<C>(item): void
Type Parameters
- C
Parameters
- item: IEventDefinition<void>
Returns void
- Defined in Store.ts:209

storeGenericItem

storeGenericItem<C>(item): void
If you want to register something to the store you can use this function.
Type Parameters
- C
Parameters
- item: RegisterableItems
Returns void
- Defined in Store.ts:180