StreamingMockCometClient | @salesforce/core

Simulates a comet client. To the core streaming client this mocks the internal comet impl. The uses setTimeout(0ms) event loop phase just so the client can simulate actual streaming without the response latency.

Hierarchy

CometClient
- StreamingMockCometClient

Index

Constructors

constructor

Properties

defaultMaxListeners

Constructors

constructor

new StreamingMockCometClient(options: StreamingMockCometSubscriptionOptions): StreamingMockCometClient

- Defined in testSetup.ts:434
Constructor

Parameters
- options: StreamingMockCometSubscriptionOptions
  
  Extends the StreamingClient options.
Returns StreamingMockCometClient

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addExtension

addExtension(extension: JsonMap): void

Overrides CometClient.addExtension
- Defined in testSetup.ts:448
Parameters
- extension: JsonMap
Returns void

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in @types/node/index.d.ts:1082
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

disable

disable(label: string): void

Overrides CometClient.disable
- Defined in testSetup.ts:450
Parameters
- label: string
Returns void

disconnect

disconnect(): Promise<void>

Overrides CometClient.disconnect
- Defined in testSetup.ts:478
Returns Promise<void>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in @types/node/index.d.ts:1094
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in @types/node/index.d.ts:1095
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in @types/node/index.d.ts:1091
Returns number

handshake

handshake(callback: function): void

Overrides CometClient.handshake
- Defined in testSetup.ts:452
Parameters
- callback: function
  - - (): void
    - Returns void
Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1096
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in @types/node/index.d.ts:1092
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in @types/node/index.d.ts:1088
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in @types/node/index.d.ts:1083
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in @types/node/index.d.ts:1084
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in @types/node/index.d.ts:1085
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in @types/node/index.d.ts:1086
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in @types/node/index.d.ts:1093
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in @types/node/index.d.ts:1089
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in @types/node/index.d.ts:1087
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setHeader

setHeader(name: string, value: string): void

Overrides CometClient.setHeader
- Defined in testSetup.ts:458
Parameters
- name: string
- value: string
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in @types/node/index.d.ts:1090
Parameters
- n: number
Returns this

subscribe

subscribe(channel: string, callback: function): CometSubscription

Overrides CometClient.subscribe
- Defined in testSetup.ts:460
Parameters
- channel: string
- callback: function
  - - (message: JsonMap): void
    - Parameters
      - message: JsonMap
      Returns void
Returns CometSubscription

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in @types/node/index.d.ts:1079
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number