Class Transports

Encapsulate the set of available transport mechanisms and expose them in an implementation independent manner.

Hierarchy

any
- Transports

Index

Constructors

constructor

Properties

Methods

get
create

Constructors

constructor

new Transports(subtransports: object): Transports

- Defined in internal/transports/transports.ts:399
Create a new Transports instance

Parameters
- subtransports: object
  
  the available subtransports
  - [name: string]: Subtransport
Returns Transports

Properties

Private emitter

emitter: Emitter

The emitter for emitting events on this stream

Private subtransports

subtransports: object

The available subtransports

Type declaration

[name: string]: Subtransport

Methods

get

get(options: OptionsImpl): CascadeDriver | null

- Defined in internal/transports/transports.ts:436
Get a new CascadeDriver with a given set of options

Parameters
- options: OptionsImpl
  
  the options from which to create a driver.
Returns CascadeDriver | null

the cascade driver if the options contain valid transports, otherwise null

Static create

create(subtransports?: undefined | object): Transports

- Defined in internal/transports/transports.ts:421
Create a new Transports object.

Parameters
- Optional subtransports: undefined | object
  
  allows specifying the available subtransports for testing. If not specified, the Subtransports * will be used.
Returns Transports