PURISTA API / @purista/core / EventBridgeBaseClass
Class: EventBridgeBaseClass<ConfigType>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:19
The base class to be extended by event bridge implementations
Extends
Extended by
Type Parameters
• ConfigType
Constructors
new EventBridgeBaseClass()
new EventBridgeBaseClass<
ConfigType>(name,config):EventBridgeBaseClass<ConfigType>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:30
Parameters
name
string
config
{ [K in string | number | symbol]: ({ defaultCommandTimeout?: number; instanceId?: string; logger?: Logger; logLevel?: LogLevelName; spanProcessor?: SpanProcessor } & ConfigType)[K] }
Returns
EventBridgeBaseClass<ConfigType>
Overrides
GenericEventEmitter.constructor
Properties
config
config:
Complete<{ [K in string | number | symbol]: ({ defaultCommandTimeout?: number; instanceId?: string; logger?: Logger; logLevel?: LogLevelName; spanProcessor?: SpanProcessor } & ConfigType)[K] }>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:23
defaultCommandTimeout
defaultCommandTimeout:
number
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:29
instanceId
instanceId:
string
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:27
logger
logger:
Logger
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:20
name
name:
string
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:25
traceProvider
traceProvider:
NodeTracerProvider
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:21
Methods
destroy()
destroy():
Promise<void>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:155
Returns
Promise<void>
emit()
emit<
K>(eventName,parameter?):void
Defined in: packages/core/src/core/types/GenericEventEmitter.ts:24
Type Parameters
• K extends EventKey<{ [key: custom-${string}]: unknown; [key: adapter-${string}]: unknown; eventbridge-connected: never; eventbridge-connection-error: unknown; eventbridge-disconnected: never; eventbridge-error: unknown; eventbridge-reconnecting: never; }>
Parameters
eventName
K
parameter?
object[K]
Returns
void
Inherited from
getTracer()
getTracer():
Tracer
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:70
Returns open telemetry tracer of this service
Returns
Tracer
Tracer
off()
off<
K>(eventName,fn):void
Defined in: packages/core/src/core/types/GenericEventEmitter.ts:20
Type Parameters
• K extends EventKey<{ [key: custom-${string}]: unknown; [key: adapter-${string}]: unknown; eventbridge-connected: never; eventbridge-connection-error: unknown; eventbridge-disconnected: never; eventbridge-error: unknown; eventbridge-reconnecting: never; }>
Parameters
eventName
K
fn
EventReceiver<object[K]>
Returns
void
Inherited from
on()
on<
K>(eventName,fn):void
Defined in: packages/core/src/core/types/GenericEventEmitter.ts:16
Type Parameters
• K extends EventKey<{ [key: custom-${string}]: unknown; [key: adapter-${string}]: unknown; eventbridge-connected: never; eventbridge-connection-error: unknown; eventbridge-disconnected: never; eventbridge-error: unknown; eventbridge-reconnecting: never; }>
Parameters
eventName
K
fn
EventReceiver<object[K]>
Returns
void
Inherited from
removeAllListeners()
removeAllListeners():
void
Defined in: packages/core/src/core/types/GenericEventEmitter.ts:28
Returns
void
Inherited from
GenericEventEmitter.removeAllListeners
start()
start():
Promise<void>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:156
Returns
Promise<void>
startActiveSpan()
startActiveSpan<
F>(name,opts,context,fn):Promise<F>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:82
Start a child span for opentelemetry tracking
Type Parameters
• F
Parameters
name
string
name of span
opts
SpanOptions
span options
context
optional context
undefined | Context
fn
(span) => Promise<F>
function to be executed within the span
Returns
Promise<F>
return value of fn
wrapInSpan()
wrapInSpan<
F>(name,opts,fn,context?):Promise<F>
Defined in: packages/core/src/core/EventBridge/EventBridgeBaseClass.impl.ts:132
Start span for opentelemetry tracking on same level. The created span will not become the "active" span within opentelemetry!
This means during logging and similar the spanId of parent span is logged.
Use wrapInSpan for marking points in flow of one bigger function, but not to trace the program flow itself
Type Parameters
• F
Parameters
name
string
name of span
opts
SpanOptions
span options
fn
(span) => Promise<F>
function te be executed in the span
context?
Context
span context
Returns
Promise<F>
return value of fn