Skip to content

Latest commit

 

History

History
56 lines (30 loc) · 1.43 KB

_index_.settingsinterface.md

File metadata and controls

56 lines (30 loc) · 1.43 KB

WebSocketAPI - v1.1.5-1 › Globals › "index" › SettingsInterface

Interface: SettingsInterface

Hierarchy

  • SettingsInterface

Index

Properties

Properties

maxLength

• maxLength: number

Defined in lib/index.ts:15

on

• on: object

Defined in lib/index.ts:23

Type declaration:

  • error? : undefined | function

  • eventCompleted(): function

  • eventReceived(): function

Optional onAuthKey

• onAuthKey? : undefined | function

Defined in lib/index.ts:22

If the onAuthKey is set as a function then the request must be authenticated before more api calls will be answered

This function can be async and if it throws an error or returns false the client will be disconnected. A truthy response will register the api.