Class Emitter

A helper class to emit CloudEvents within an application

Hierarchy

Emitter

Index

Constructors

constructor

Properties

instance

Methods

Constructors

constructor

new Emitter(): Emitter

Returns Emitter

Properties

Static instance

instance: undefined | EventEmitter = undefined

Singleton store

Methods

Static emitEvent

emitEvent<T>(event: CloudEvent<T>, ensureDelivery?: boolean): Promise<void>

- Defined in src/transport/emitter.ts:112
Emit an event inside this application

Type Parameters
- T
Parameters
- event: CloudEvent<T>
  
  to emit
- ensureDelivery: boolean = true
  
  fail the promise if one listener fails
Returns Promise<void>

Static getInstance

getInstance(): EventEmitter

- Defined in src/transport/emitter.ts:87
Return or create the Emitter singleton

Returns EventEmitter
return Emitter singleton

Static on

on(event: "cloudevent" | "newListener" | "removeListener", listener: ((...args: any[]) => void)): void

- Defined in src/transport/emitter.ts:101
Add a listener for eventing

Parameters
- event: "cloudevent" | "newListener" | "removeListener"
  
  type to listen to
- listener: ((...args: any[]) => void)
  
  to call on event
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

Generated using TypeDoc