Class Backoff

Hierarchy

EventEmitter
- Backoff

Index

Constructors

constructor

Properties

defaultMaxListeners

Methods

Constructors

constructor

new Backoff(options: any): Backoff

- Defined in lib/twilio/backoff.ts:10
Construct a Backoff.

property

{number} min - Initial timeout in milliseconds [100]

property

{number} max - Max timeout [10000]

property

{boolean} jitter - Apply jitter [0]

property

{number} factor - Multiplication factor for Backoff operation [2]

Parameters
- options: any
Returns Backoff

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from Backoff.addListener

Overrides EventEmitter.addListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

backoff

backoff(): void

- Defined in lib/twilio/backoff.ts:51
Returns void

emit

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

Inherited from Backoff.emit

Overrides EventEmitter.emit
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from Backoff.eventNames

Overrides EventEmitter.eventNames
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from Backoff.getMaxListeners

Overrides EventEmitter.getMaxListeners
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from Backoff.listenerCount

Overrides EventEmitter.listenerCount
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from Backoff.listeners

Overrides EventEmitter.listeners
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from Backoff.off

Overrides EventEmitter.off
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 Backoff.on

Overrides EventEmitter.on
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 Backoff.once

Overrides EventEmitter.once
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 Backoff.prependListener

Overrides EventEmitter.prependListener
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 Backoff.prependOnceListener

Overrides EventEmitter.prependOnceListener
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 Backoff.rawListeners

Overrides EventEmitter.rawListeners
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Backoff.removeAllListeners

Overrides EventEmitter.removeAllListeners
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from Backoff.removeListener

Overrides EventEmitter.removeListener
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

reset

reset(): void

- Defined in lib/twilio/backoff.ts:65
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from Backoff.setMaxListeners

Overrides EventEmitter.setMaxListeners
Parameters
- n: number
Returns this

Static listenerCount

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

Inherited from Backoff.listenerCount
deprecated

since v4.0.0

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

Generated using TypeDoc