Class Store

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

Index

Constructors

Constructors

constructor

new Store(
    eventManager: EventManager,
    logger: Logger,
    onUnhandledError: OnUnhandledError,
    mode?: RunnerMode,
    lifecycleAdmissionController?: LifecycleAdmissionController,
    executionContextStore?: ExecutionContextStore,
): Store
Parameters
- eventManager: EventManager
- logger: Logger
- onUnhandledError: OnUnhandledError
- Optionalmode: RunnerMode
- OptionallifecycleAdmissionController: LifecycleAdmissionController
- OptionalexecutionContextStore: ExecutionContextStore
Returns Store
- Defined in src/models/store/Store.ts:78

Properties

`Protected` `Readonly`eventManager

eventManager: EventManager

`Protected` `Readonly`logger

logger: Logger

`Readonly`lookup

lookup: StoreLookup

mode

mode: RunnerMode

`Readonly`onUnhandledError

onUnhandledError: OnUnhandledError

root

root: definitions.ResourceStoreElementType

Accessors

asyncContexts

get asyncContexts(): LockableMap<string, IAsyncContext<any>>
Returns LockableMap<string, IAsyncContext<any>>
- Defined in src/models/store/Store.ts:152

errors

get errors(): LockableMap<string, IErrorHelper<any>>
Returns LockableMap<string, IErrorHelper<any>>
- Defined in src/models/store/Store.ts:149

events

get events(): LockableMap<string, definitions.EventStoreElementType>
Returns LockableMap<string, definitions.EventStoreElementType>
- Defined in src/models/store/Store.ts:146

hooks

get hooks(): LockableMap<string, HookStoreElementType>
Returns LockableMap<string, HookStoreElementType>
- Defined in src/models/store/Store.ts:140

isLocked

get isLocked(): boolean
Returns boolean
- Defined in src/models/store/Store.ts:170

overrideRequests

get overrideRequests(): { override: RegisterableItem; source: string }[]
Returns { override: RegisterableItem; source: string }[]
- Defined in src/models/store/Store.ts:167

overrides

get overrides(): Map<string, SupportedOverride>
Returns Map<string, SupportedOverride>
- Defined in src/models/store/Store.ts:164

resourceMiddlewares

get resourceMiddlewares(): LockableMap<
string,
ResourceMiddlewareStoreElementType,
>
Returns LockableMap<string, ResourceMiddlewareStoreElementType>
- Defined in src/models/store/Store.ts:158

resources

get resources(): LockableMap<string, definitions.ResourceStoreElementType>
Returns LockableMap<string, definitions.ResourceStoreElementType>
- Defined in src/models/store/Store.ts:143

taskMiddlewares

get taskMiddlewares(): LockableMap<string, TaskMiddlewareStoreElementType>
Returns LockableMap<string, TaskMiddlewareStoreElementType>
- Defined in src/models/store/Store.ts:155

tasks

get tasks(): LockableMap<string, definitions.TaskStoreElementType>
Returns LockableMap<string, definitions.TaskStoreElementType>
- Defined in src/models/store/Store.ts:137

Methods

abortInFlightTaskSignals

abortInFlightTaskSignals(reason: string): void
Parameters
- reason: string
Returns void
- Defined in src/models/store/Store.ts:341

assertLazyResourceWakeupAllowed

assertLazyResourceWakeupAllowed(resourceId: string): void
Parameters
- resourceId: string
Returns void
- Defined in src/models/store/Store.ts:454

beginAborting

beginAborting(): void
Returns void
- Defined in src/models/store/Store.ts:325

beginCoolingDown

beginCoolingDown(): void
Returns void
- Defined in src/models/store/Store.ts:321

beginDisposing

beginDisposing(): void
Returns void
- Defined in src/models/store/Store.ts:317

beginDrained

beginDrained(): void
Returns void
- Defined in src/models/store/Store.ts:329

canAdmitTaskCall

canAdmitTaskCall(source: RuntimeCallSource): boolean
Parameters
- source: RuntimeCallSource
Returns boolean
- Defined in src/models/store/Store.ts:313

cancelDrainWaiters

cancelDrainWaiters(): void
Returns void
- Defined in src/models/store/Store.ts:345

checkLock

checkLock(): void
Returns void
- Defined in src/models/store/Store.ts:362

cooldown

cooldown(options?: { shouldStop?: () => boolean }): Promise<void>
Parameters
- Optionaloptions: { shouldStop?: () => boolean }
Returns Promise<void>
- Defined in src/models/store/Store.ts:436

`Protected`cooldownWave

cooldownWave(
wave: definitions.DisposeWave,
options?: { shouldStop?: () => boolean },
): Promise<Error[]>
Parameters
- wave: definitions.DisposeWave
- Optionaloptions: { shouldStop?: () => boolean }
Returns Promise<Error[]>
- Defined in src/models/store/Store.ts:440

`Protected`createEventManagerFacade

createEventManagerFacade(): EventManager
Returns EventManager
- Defined in src/models/store/Store.ts:372

dispose

dispose(): Promise<void>
Returns Promise<void>
- Defined in src/models/store/Store.ts:416

enterShutdownLockdown

enterShutdownLockdown(): void
Returns void
- Defined in src/models/store/Store.ts:353

findDefinitionById

findDefinitionById(canonicalId: string): RegisterableItem
Parameters
- canonicalId: string
Returns RegisterableItem
- Defined in src/models/store/Store.ts:243

findIdByDefinition

findIdByDefinition(definition: unknown): string
Parameters
- definition: unknown
Returns string
- Defined in src/models/store/Store.ts:228

getAccessViolation

getAccessViolation(
    targetId: string,
    consumerId: string,
    channel?: IsolationChannel,
): AccessViolation | null
Parameters
- targetId: string
- consumerId: string
- channel: IsolationChannel = "dependencies"
Returns AccessViolation | null
- Defined in src/models/store/Store.ts:202

getExecutionContextStore

getExecutionContextStore(): ExecutionContextStore
Returns ExecutionContextStore
- Defined in src/models/store/Store.ts:182

getHealthReporter

getHealthReporter(): HealthReporter
Returns HealthReporter
- Defined in src/models/store/Store.ts:186

getLifecycleAdmissionController

getLifecycleAdmissionController(): LifecycleAdmissionController
Returns LifecycleAdmissionController
- Defined in src/models/store/Store.ts:178

getMiddlewareManager

getMiddlewareManager(): MiddlewareManager
Returns MiddlewareManager
- Defined in src/models/store/Store.ts:174

getOwnerResourceId

getOwnerResourceId(itemId: string): string | undefined
Parameters
- itemId: string
Returns string | undefined
- Defined in src/models/store/Store.ts:214

getRootAccessInfo

getRootAccessInfo(
targetId: string,
rootId: string,
): { accessible: boolean; exportedIds: string[] }
Parameters
- targetId: string
- rootId: string
Returns { accessible: boolean; exportedIds: string[] }
- Defined in src/models/store/Store.ts:294

getTagAccessor

getTagAccessor<TTag extends ITag<any, any, any, any>>(
tag: TTag,
options?: { consumerId?: string; includeSelf?: boolean },
): TagDependencyAccessor<TTag>
Type Parameters
- TTag extends ITag<any, any, any, any>
Parameters
- tag: TTag
- Optionaloptions: { consumerId?: string; includeSelf?: boolean }
Returns TagDependencyAccessor<TTag>
- Defined in src/models/store/Store.ts:468

hasDefinition

hasDefinition(definition: unknown): boolean
Parameters
- definition: unknown
Returns boolean
- Defined in src/models/store/Store.ts:271

hasExportsDeclaration

hasExportsDeclaration(resourceId: string): boolean
Parameters
- resourceId: string
Returns boolean
- Defined in src/models/store/Store.ts:301

hasId

hasId(canonicalId: string): boolean
Parameters
- canonicalId: string
Returns boolean
- Defined in src/models/store/Store.ts:280

initializeStore

initializeStore(
    root: IResource<any, any, any, any, any>,
    config: unknown,
    runtimeResult: RunResult<unknown>,
    options?: {
        debug?: DebugFriendlyConfig;
        executionContext?: ExecutionContextConfig | null;
        identity?: IdentityAsyncContext | null;
    },
): void
Parameters
- root: IResource<any, any, any, any, any>
- config: unknown
- runtimeResult: RunResult<unknown>
- Optionaloptions: {
      debug?: DebugFriendlyConfig;
      executionContext?: ExecutionContextConfig | null;
      identity?: IdentityAsyncContext | null;
  }
Returns void
- Defined in src/models/store/Store.ts:398

isDisposalStarted

isDisposalStarted(): boolean
Returns boolean
- Defined in src/models/store/Store.ts:309

isInShutdownLockdown

isInShutdownLockdown(): boolean
Returns boolean
- Defined in src/models/store/Store.ts:305

isItemVisibleToConsumer

isItemVisibleToConsumer(
    targetId: string,
    consumerId: string,
    channel?: IsolationChannel,
): boolean
Parameters
- targetId: string
- consumerId: string
- channel: IsolationChannel = "dependencies"
Returns boolean
- Defined in src/models/store/Store.ts:190

isItemWithinResourceSubtree

isItemWithinResourceSubtree(resourceId: string, itemId: string): boolean
Parameters
- resourceId: string
- itemId: string
Returns boolean
- Defined in src/models/store/Store.ts:284

lock

lock(): void
Returns void
- Defined in src/models/store/Store.ts:357

markDisposed

markDisposed(): void
Returns void
- Defined in src/models/store/Store.ts:349

processOverrides

processOverrides(): void
Returns void
- Defined in src/models/store/Store.ts:458

ready

ready(options?: { shouldStop?: () => void }): Promise<void>
Parameters
- Optionaloptions: { shouldStop?: () => void }
Returns Promise<void>
- Defined in src/models/store/Store.ts:428

readyResource

readyResource(resourceId: string): Promise<void>
Parameters
- resourceId: string
Returns Promise<void>
- Defined in src/models/store/Store.ts:432

`Protected`readyWave

readyWave(
wave: definitions.DisposeWave,
options?: { shouldStop?: () => void },
): Promise<void>
Parameters
- wave: definitions.DisposeWave
- Optionaloptions: { shouldStop?: () => void }
Returns Promise<void>
- Defined in src/models/store/Store.ts:447

recordInitWave

recordInitWave(resourceIds: readonly string[]): void
Parameters
- resourceIds: readonly string[]
Returns void
- Defined in src/models/store/Store.ts:424

recordResourceInitialized

recordResourceInitialized(resourceId: string): void
Parameters
- resourceId: string
Returns void
- Defined in src/models/store/Store.ts:420

resolveHookTargets

resolveHookTargets(
hook: Pick<IHook<any, any, any>, "id" | "on">,
): HookTargetResolutionEntry[]
Parameters
- hook: Pick<IHook<any, any, any>, "id" | "on">
Returns HookTargetResolutionEntry[]
- Defined in src/models/store/Store.ts:222

resolveRegisteredDefinition

resolveRegisteredDefinition<TDefinition extends RegisterableItem>(
definition: TDefinition,
): TDefinition
Type Parameters
- TDefinition extends RegisterableItem
Parameters
- definition: TDefinition
Returns TDefinition
- Defined in src/models/store/Store.ts:255

`Protected`resolveRootEntry

resolveRootEntry(
rootDefinition: IResource<any>,
): definitions.ResourceStoreElementType
Parameters
- rootDefinition: IResource<any>
Returns definitions.ResourceStoreElementType
- Defined in src/models/store/Store.ts:376

setTaskRunner

setTaskRunner(taskRunner: TaskRunner): void
Parameters
- taskRunner: TaskRunner
Returns void
- Defined in src/models/store/Store.ts:368

storeGenericItem

storeGenericItem<C>(item: RegisterableItem): void
Type Parameters
- C
Parameters
- item: RegisterableItem
Returns void
- Defined in src/models/store/Store.ts:464

trackTaskAbortController

trackTaskAbortController(controller: AbortController): () => void
Parameters
- controller: AbortController
Returns () => void
- Defined in src/models/store/Store.ts:337

validateDependencyGraph

validateDependencyGraph(): void
Returns void
- Defined in src/models/store/Store.ts:382

validateEventEmissionGraph

validateEventEmissionGraph(): void
Returns void
- Defined in src/models/store/Store.ts:390

waitForDrain

waitForDrain(drainingBudgetMs: number): Promise<boolean>
Parameters
- drainingBudgetMs: number
Returns Promise<boolean>
- Defined in src/models/store/Store.ts:333

Class Store

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Store

Properties

Protected ReadonlyeventManager

Protected Readonlylogger

Readonlylookup

mode

ReadonlyonUnhandledError

root

Accessors

asyncContexts

Returns LockableMap<string, IAsyncContext<any>>

errors

Returns LockableMap<string, IErrorHelper<any>>

events

Returns LockableMap<string, definitions.EventStoreElementType>

hooks

Returns LockableMap<string, HookStoreElementType>

isLocked

Returns boolean

overrideRequests

Returns { override: RegisterableItem; source: string }[]

overrides

Returns Map<string, SupportedOverride>

resourceMiddlewares

Returns LockableMap<string, ResourceMiddlewareStoreElementType>

resources

Returns LockableMap<string, definitions.ResourceStoreElementType>

tags

Returns LockableMap<string, ITag<void, void, void, void>>

taskMiddlewares

Returns LockableMap<string, TaskMiddlewareStoreElementType>

tasks

Returns LockableMap<string, definitions.TaskStoreElementType>

Methods

abortInFlightTaskSignals

Parameters

Returns void

assertLazyResourceWakeupAllowed

Parameters

Returns void

beginAborting

Returns void

beginCoolingDown

Returns void

beginDisposing

Returns void

beginDrained

Returns void

canAdmitTaskCall

Parameters

Returns boolean

cancelDrainWaiters

Returns void

checkLock

Returns void

cooldown

Parameters

Returns Promise<void>

ProtectedcooldownWave

Parameters

Returns Promise<Error[]>

ProtectedcreateEventManagerFacade

Returns EventManager

dispose

Returns Promise<void>

enterShutdownLockdown

Returns void

findDefinitionById

Parameters

Returns RegisterableItem

findIdByDefinition

`Protected` `Readonly`eventManager

`Protected` `Readonly`logger

`Readonly`lookup

`Readonly`onUnhandledError

`Protected`cooldownWave

`Protected`createEventManagerFacade

`Protected`readyWave