Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types.d"

Index

Type aliases

CommandType

CommandType: "get" | "set" | "operate" | "add" | "delete" | "notify"

USP Commands

IClientOptions

IClientOptions: IClientOptions

JSObject

JSObject: {}

Representation of JS object

Type declaration

JSType

JSType: number | boolean | string | JSObject

Represents js types

MessageType

MessageType: CommandType | "error"

Message types

OperateCleanupFunction

OperateCleanupFunction: () => Promise<void>

Cleans up command subscription

Type declaration

    • (): Promise<void>
    • Returns Promise<void>

OperateFunction

OperateFunction: (input?: JSObject) => Promise<JSType>

Executes a command

Type declaration

PromiseResult

PromiseResult: { reject: any; resolve: any }

Stores promise resolve and reject responses

Type declaration

  • reject: any
  • resolve: any

Role

Role: "admin" | "user" | "none"

Session role

Router

Router: Map<string, PromiseResult>

Routes messages

SendFn

SendFn: (command: CommandType, args: Partial<EncodeArgs>) => Promise<USPMessage>

Send Function

Type declaration

USPMessage

Union of Messages

Generated using TypeDoc