Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

Type aliases

AddFn

AddFn: (path: string, input?: JSObject) => Promise<string>

Type declaration

    • (path: string, input?: JSObject): Promise<string>
    • Parameters

      Returns Promise<string>

DelFn

DelFn: (path: string | string[]) => Promise<void>

Type declaration

    • (path: string | string[]): Promise<void>
    • Parameters

      • path: string | string[]

      Returns Promise<void>

Variables

Const commandsWithReturnValue

commandsWithReturnValue: string[] = ["get", "notify", "add"]

Set of commands which have a return value

Const operateSubscriptionPath

operateSubscriptionPath: "Device.LocalAgent.Subscription." = "Device.LocalAgent.Subscription."

Functions

Const addDot

  • addDot(s: string): string
  • Add dot to the end of a string if it does not have one

    Parameters

    • s: string

    Returns string

Const connect

  • Connect to device

    Parameters

    Returns Promise<Device>

    A set of functions for interacting with the device

Const decode

  • Transform USPMessage to expected response type

    Parameters

    Returns JSType | void

Const handleSend

  • handleSend(msg: Promise<USPMessage>, path: string | string[]): Promise<string | number | false | true | void | JSObject>
  • Wrapper function for sending message (decode message and catch errors)

    Parameters

    • msg: Promise<USPMessage>
    • path: string | string[]

    Returns Promise<string | number | false | true | void | JSObject>

Const isError

  • Checks if response is an ErrorMessage

    Parameters

    Returns resp is ErrorMessage

Const isPromiseResult

  • isPromiseResult(res: any): res is PromiseResult
  • Checks if value is of type PromiseResult

    Parameters

    • res: any

    Returns res is PromiseResult

Const isReference

  • isReference(s: string): boolean
  • Checks if string is reference

    Parameters

    • s: string

    Returns boolean

Const makeAdd

  • makeAdd(send: SendFn): (Anonymous function)
  • Make add function

    Parameters

    Returns (Anonymous function)

Const makeDel

  • makeDel(send: SendFn): (Anonymous function)
  • Make del function

    Parameters

    Returns (Anonymous function)

Const makeGet

  • makeGet(send: SendFn): (Anonymous function)
  • Make get function

    Parameters

    Returns (Anonymous function)

Const makeOperate

  • Make operate function

    Parameters

    Returns (Anonymous function)

Const makeSet

  • makeSet(send: SendFn): (Anonymous function)
  • Make set function

    Parameters

    Returns (Anonymous function)

Const resolveReferences

  • resolveReferences(msg: JSType, get: (paths: string | string[]) => Promise<JSType>, level: number): Promise<JSType>
  • Resolve references in message

    Parameters

    • msg: JSType

      Message containing reference

    • get: (paths: string | string[]) => Promise<JSType>

      Function to retrieve value given reference

        • (paths: string | string[]): Promise<JSType>
        • Parameters

          • paths: string | string[]

          Returns Promise<JSType>

    • level: number

      Number of nest levels to resolve

    Returns Promise<JSType>

Const splitReference

  • splitReference(s: string): string[]
  • Split reference string

    Parameters

    • s: string

    Returns string[]

Const throwError

  • throwError(reason: any): void
  • Shorthand for throwing generic error

    Parameters

    • reason: any

    Returns void

Const throwMsgError

  • throwMsgError(path: string | string[]): (Anonymous function)
  • Shorthand for throwing message-related error

    Parameters

    • path: string | string[]

    Returns (Anonymous function)

Generated using TypeDoc