Interface WebsocketOptions

Options for websocket based connections in browser

Hierarchy

WebsocketOptionsBase
- WebsocketOptions

Index

Properties

headers? protocol? create_signing_config? service?

Properties

`Optional` headers

headers?: {
[index: string]: string;
}

Additional headers to add

Type declaration

[index: string]: string

`Optional` protocol

protocol?: string

Websocket protocol, used during Upgrade

`Optional` create_signing_config

create_signing_config?: (() => AwsSigningConfigBase)

Type declaration

- (): AwsSigningConfigBase
- (Optional) factory function to create the configuration used to sign the websocket handshake. Leave null to use the default settings.
  
  Returns AwsSigningConfigBase

`Optional` service

service?: string

(Optional) override for the service name used in signing the websocket handshake. Leave null to use the default (iotdevicegateway)

Generated using TypeDoc