Class CancellationContext

Hierarchy

ScopeContextBase
- CancellationContext

Index

Constructors

Properties

Accessors

parent currentContext currentToken hasCurrent

Methods

cancel dispose getCancellationToken getSignal onScopeDispose onScopeInvoke create

Constructors

constructor

new CancellationContext(): CancellationContext
Returns CancellationContext
Overrides ScopeContextBase.constructor
- Defined in @tessa/core/src/scope/cancellationContext.ts:17

Properties

`Readonly` onCancel

onCancel: EventHandler<CancellationContextEvent, CancellationContext>

Accessors

parent

get parent(): null | CancellationContext
Returns null | CancellationContext
- Defined in @tessa/core/src/scope/cancellationContext.ts:33

`Static` currentContext

get currentContext(): null | CancellationContext
Returns null | CancellationContext
- Defined in @tessa/core/src/scope/cancellationContext.ts:112

`Static` currentToken

get currentToken(): CancellationToken
Returns CancellationToken
- Defined in @tessa/core/src/scope/cancellationContext.ts:107

`Static` hasCurrent

get hasCurrent(): boolean
Returns boolean
- Defined in @tessa/core/src/scope/cancellationContext.ts:116

Methods

cancel

cancel(reason?: string): void
Parameters
- Optional reason: string
Returns void
- Defined in @tessa/core/src/scope/cancellationContext.ts:60

dispose

dispose(): void
Returns void
- Defined in @tessa/core/src/scope/cancellationContext.ts:55

getCancellationToken

getCancellationToken(): CancellationToken
Returns CancellationToken
- Defined in @tessa/core/src/scope/cancellationContext.ts:86

getSignal

getSignal(): [AbortSignal, VoidFunction]
Returns [AbortSignal, VoidFunction]
- Defined in @tessa/core/src/scope/cancellationContext.ts:64

onScopeDispose

onScopeDispose(scope: IScopeInstance<CancellationContext>): void
Parameters
- scope: IScopeInstance<CancellationContext>
Returns void
Overrides ScopeContextBase.onScopeDispose
- Defined in @tessa/core/src/scope/cancellationContext.ts:50

onScopeInvoke

onScopeInvoke(scope: IScopeInstance<ScopeContextBase>): void
Parameters
- scope: IScopeInstance<ScopeContextBase>
Returns void
Overrides ScopeContextBase.onScopeInvoke
- Defined in @tessa/core/src/scope/cancellationContext.ts:43

`Static` create

create(context: null | CancellationContext): IScopeInstance<CancellationContext>
Parameters
- context: null | CancellationContext
Returns IScopeInstance<CancellationContext>
- Defined in @tessa/core/src/scope/cancellationContext.ts:120

Generated using TypeDoc