Class ExecutionContext<T, RegistryMap>

Type Parameters

T extends AnyRecord
RegistryMap extends AnyRecord

Hierarchy

ExecutionContext

Index

Constructors

Properties

abortSignal applyEffects attachToThread componentsToRemove effectFactories effects fork getRegistryApi parentThread registry registryInstance removeEffectFunctions using

Methods

branchDependencies

Constructors

constructor

new ExecutionContext<T, RegistryMap>(parentThread, registryInstance, effectFactories?, parentContext?): ExecutionContext<T, RegistryMap>
Type Parameters
- T extends AnyRecord
- RegistryMap extends AnyRecord
Parameters
- parentThread: Thread
- registryInstance: Registry
- Optional effectFactories: EffectFactory<AnyExecutionContext, any>[]
- Optional parentContext: ExecutionContext<Partial<T>, RegistryMap>
Returns ExecutionContext<T, RegistryMap>
- Defined in dist/sdk/tmp-typedoc/framework-types/execution-context/ExecutionContext.d.ts:21

Properties

`Readonly` abortSignal

abortSignal: AbortSignal

`Private` applyEffects

applyEffects: any

`Private` attachToThread

attachToThread: any

`Private` `Readonly` componentsToRemove

componentsToRemove: any

`Private` `Readonly` effectFactories

effectFactories: any

effects

effects: T

fork

fork: (<NP>(task, parameter, handleError?) => Abortable<TaskReturn<NP>>)

Type declaration

- <NP>(task, parameter, handleError?): Abortable<TaskReturn<NP>>
- Type Parameters
  - NP extends NamedTask<Task<any, any, any>>
  Parameters
  - task: ContextualizedTask<ExecutionContext<T, RegistryMap>, NP>
  - parameter: TaskParam<NP>
  - Optional handleError: ((error) => boolean)
    - (error): boolean
      
      Parameters
      
      error: Error
      
      Returns boolean
  Returns Abortable<TaskReturn<NP>>

`Private` getRegistryApi

getRegistryApi: any

`Private` `Readonly` parentThread

parentThread: any

`Readonly` registry

registry: RegistryInterface<RegistryMap, StringIndexable<RegistryMap>>

`Private` registryInstance

registryInstance: any

`Private` removeEffectFunctions

removeEffectFunctions: any

using

using: (<U>(...factories) => ExecutionContext<T & UnionToIntersection<FactoryEffect<U[number]>>, RegistryMap>)

Type declaration

- <U>(...factories): ExecutionContext<T & UnionToIntersection<FactoryEffect<U[number]>>, RegistryMap>
- Type Parameters
  - U extends EffectFactory<ExecutionContext<T, RegistryMap>, AnyRecord>[]
  Parameters
  - Rest ...factories: U
  Returns ExecutionContext<T & UnionToIntersection<FactoryEffect<U[number]>>, RegistryMap>

Methods

branchDependencies

branchDependencies(): ExecutionContext<T, RegistryMap>
Returns ExecutionContext<T, RegistryMap>
- Defined in dist/sdk/tmp-typedoc/framework-types/execution-context/ExecutionContext.d.ts:27

framework-types
- abortable
  - Abortable.d.ts
    - Abortable
    - abortAndWaitForExit
    - forEach
    - isAbortable
    - linkAbortSignal
    - map
    - race
    - rejectAfter
    - resolveAfter
    - rightCompose
    - sequence
    - waitForExit
  - Types.d.ts
    - AbortableCreator
    - CheckChained
    - Head
    - Last
    - Tail
- api-manager
  - ApiManager.d.ts
    - ApiManager
    - Property
  - Errors.d.ts
    - ApiDisposedError
- data-structures
  - MapWithDefault.d.ts
    - MapWithDefault
  - Types.d.ts
    - GenericHashMap
- effect
  - EffectFactory.d.ts
    - createEffectFactory
  - Types.d.ts
    - AnyEffectFactory
    - EffectFactory
- effects
- error
  - FrameworkDisposedError.d.ts
    - FrameworkDisposedError
  - FrameworkError.d.ts
    - FrameworkError
- event-bus
  - EventBus.d.ts
    - EventBus
    - Detach
    - Listener
- execution-context
- package-api
- polyfills
- registry
  - Registry.d.ts
    - Registry
  - RegistryInterface.d.ts
    - RegistryInterface
    - Replacer
- task
  - Task.d.ts
    - bindTask
    - isTask
  - TaskUtils.d.ts
  - Types.d.ts
    - AnyContextTask
    - AnyNamedTask
    - AnyParameterTask
    - AnyTask
    - BoundTask
    - NamedTask
    - Task
    - TaskParam
    - TaskReturn
- thread
  - Thread.d.ts
  - ThreadEventBus.d.ts
- utils
  - debug
    - thread
      - ThreadDecorator.d.ts
        
        ThreadDebugDecorator
  - Awaitable.d.ts
    - Awaitable
  - Deferred.d.ts
    - Deferred
  - StringUtils.d.ts
    - generateId
- index.d.ts
  - WithBaseApi
  - framework
- BaseTypes.d.ts
- Types.d.ts
  - BaseContext
- framework.d.ts
  - WithBaseApi
  - framework
player-types

Class ExecutionContext<T, RegistryMap>

Type Parameters

T extends AnyRecord

RegistryMap extends AnyRecord

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends AnyRecord

RegistryMap extends AnyRecord

Parameters

parentThread: Thread

registryInstance: Registry

Optional effectFactories: EffectFactory<AnyExecutionContext, any>[]

Optional parentContext: ExecutionContext<Partial<T>, RegistryMap>

Returns ExecutionContext<T, RegistryMap>

Properties

Readonly abortSignal

Private applyEffects

Private attachToThread

Private Readonly componentsToRemove

Private Readonly effectFactories

effects

fork

Type declaration

Type Parameters

NP extends NamedTask<Task<any, any, any>>

Parameters

task: ContextualizedTask<ExecutionContext<T, RegistryMap>, NP>

parameter: TaskParam<NP>

Optional handleError: ((error) => boolean)

Parameters

error: Error

Returns boolean

Returns Abortable<TaskReturn<NP>>

Private getRegistryApi

Private Readonly parentThread

Readonly registry

Private registryInstance

Private removeEffectFunctions

using

Type declaration

Type Parameters

U extends EffectFactory<ExecutionContext<T, RegistryMap>, AnyRecord>[]

Parameters

Rest ...factories: U

Returns ExecutionContext<T & UnionToIntersection<FactoryEffect<U[number]>>, RegistryMap>

Methods

branchDependencies

Returns ExecutionContext<T, RegistryMap>

Settings

Member Visibility

Theme

On This Page

`Optional` effectFactories: EffectFactory<AnyExecutionContext, any>[]

`Optional` parentContext: ExecutionContext<Partial<T>, RegistryMap>

`Readonly` abortSignal

`Private` applyEffects

`Private` attachToThread

`Private` `Readonly` componentsToRemove

`Private` `Readonly` effectFactories

`Optional` handleError: ((error) => boolean)

`Private` getRegistryApi

`Private` `Readonly` parentThread

`Readonly` registry

`Private` registryInstance

`Private` removeEffectFunctions

`Rest` ...factories: U