Class ContextAPI

Singleton object which represents the entry point to the OpenTelemetry Context API

Hierarchy

ContextAPI

Index

Methods

Methods

active

active(): Context

- Defined in api/src/api/context.ts:59
Get the currently active context

Returns Context

bind

bind<T>(context: Context, target: T): T

- Defined in api/src/api/context.ts:86
Bind a context to a target function or event emitter

Type Parameters
- T
Parameters
- context: Context
  
  context to bind to the event emitter or function. Defaults to the currently active context
- target: T
  
  function or event emitter to bind
Returns T

disable

disable(): void

- Defined in api/src/api/context.ts:95
Disable and remove the global context manager

Returns void

setGlobalContextManager

setGlobalContextManager(contextManager: ContextManager): boolean

- Defined in api/src/api/context.ts:52
Set the current context manager.

Parameters
- contextManager: ContextManager
Returns boolean
true if the context manager was successfully registered, else false

with

with<A, F>(context: Context, fn: F, thisArg?: ThisParameterType<F>, ...args: A): ReturnType<F>

- Defined in api/src/api/context.ts:71
Execute a function with an active context

Type Parameters
- A extends unknown[]
- F extends ((...args: A) => ReturnType<F>)
Parameters
- context: Context
  
  context to be active during function execution
- fn: F
  
  function to execute in a context
- Optional thisArg: ThisParameterType<F>
  
  optional receiver to be used for calling fn
- Rest ...args: A
  
  optional arguments forwarded to fn
Returns ReturnType<F>

Static getInstance

getInstance(): ContextAPI

- Defined in api/src/api/context.ts:39
Get the singleton instance of the Context API

Returns ContextAPI

Generated using TypeDoc