Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @swim/client

@swim/client

Web Agent Client.

Index

Type aliases

DownlinkDidClose

DownlinkDidClose: function

Type declaration

DownlinkDidConnect

DownlinkDidConnect: function

Type declaration

DownlinkDidDisconnect

DownlinkDidDisconnect: function

Type declaration

DownlinkDidFail

DownlinkDidFail: function

Type declaration

    • (error: unknown, downlink: Downlink): void
    • Parameters

      Returns void

DownlinkDidLink

DownlinkDidLink: function

Type declaration

DownlinkDidSync

DownlinkDidSync: function

Type declaration

DownlinkDidUnlink

DownlinkDidUnlink: function

Type declaration

DownlinkOnCommand

DownlinkOnCommand: function

Type declaration

    • (body: Value, downlink: Downlink): void
    • Parameters

      Returns void

DownlinkOnEvent

DownlinkOnEvent: function

Type declaration

    • (body: Value, downlink: Downlink): void
    • Parameters

      Returns void

DownlinkType

DownlinkType: "event" | "list" | "map" | "value"

DownlinkWillLink

DownlinkWillLink: function

Type declaration

DownlinkWillSync

DownlinkWillSync: function

Type declaration

DownlinkWillUnlink

DownlinkWillUnlink: function

Type declaration

ListDownlinkDidClear

ListDownlinkDidClear: function

Type declaration

ListDownlinkDidDrop

ListDownlinkDidDrop: function

Type declaration

    • Parameters

      Returns void

ListDownlinkDidInsert

ListDownlinkDidInsert: function

Type declaration

    • (index: number, newValue: V, downlink: ListDownlink<V, VU>): void
    • Parameters

      Returns void

ListDownlinkDidMove

ListDownlinkDidMove: function

Type declaration

    • (fromIndex: number, toIndex: number, value: V, downlink: ListDownlink<V, VU>): void
    • Parameters

      • fromIndex: number
      • toIndex: number
      • value: V
      • downlink: ListDownlink<V, VU>

      Returns void

ListDownlinkDidRemove

ListDownlinkDidRemove: function

Type declaration

    • (index: number, oldValue: V, downlink: ListDownlink<V, VU>): void
    • Parameters

      Returns void

ListDownlinkDidTake

ListDownlinkDidTake: function

Type declaration

    • Parameters

      Returns void

ListDownlinkDidUpdate

ListDownlinkDidUpdate: function

Type declaration

    • (index: number, newValue: V, oldValue: V, downlink: ListDownlink<V, VU>): void
    • Parameters

      • index: number
      • newValue: V
      • oldValue: V
      • downlink: ListDownlink<V, VU>

      Returns void

ListDownlinkWillClear

ListDownlinkWillClear: function

Type declaration

ListDownlinkWillDrop

ListDownlinkWillDrop: function

Type declaration

    • Parameters

      Returns void

ListDownlinkWillInsert

ListDownlinkWillInsert: function

Type declaration

    • (index: number, newValue: V, downlink: ListDownlink<V, VU>): V | void
    • Parameters

      Returns V | void

ListDownlinkWillMove

ListDownlinkWillMove: function

Type declaration

    • (fromIndex: number, toIndex: number, value: V, downlink: ListDownlink<V, VU>): void
    • Parameters

      • fromIndex: number
      • toIndex: number
      • value: V
      • downlink: ListDownlink<V, VU>

      Returns void

ListDownlinkWillRemove

ListDownlinkWillRemove: function

Type declaration

    • Parameters

      Returns void

ListDownlinkWillTake

ListDownlinkWillTake: function

Type declaration

    • Parameters

      Returns void

ListDownlinkWillUpdate

ListDownlinkWillUpdate: function

Type declaration

    • (index: number, newValue: V, downlink: ListDownlink<V, VU>): V | void
    • Parameters

      Returns V | void

MapDownlinkDidClear

MapDownlinkDidClear: function

Type declaration

MapDownlinkDidDrop

MapDownlinkDidDrop: function

Type declaration

    • (lower: number, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      Returns void

MapDownlinkDidRemove

MapDownlinkDidRemove: function

Type declaration

    • (key: K, oldValue: V, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      • key: K
      • oldValue: V
      • downlink: MapDownlink<K, V, KU, VU>

      Returns void

MapDownlinkDidTake

MapDownlinkDidTake: function

Type declaration

    • (upper: number, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      Returns void

MapDownlinkDidUpdate

MapDownlinkDidUpdate: function

Type declaration

    • (key: K, newValue: V, oldValue: V, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      • key: K
      • newValue: V
      • oldValue: V
      • downlink: MapDownlink<K, V, KU, VU>

      Returns void

MapDownlinkWillClear

MapDownlinkWillClear: function

Type declaration

MapDownlinkWillDrop

MapDownlinkWillDrop: function

Type declaration

    • (lower: number, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      Returns void

MapDownlinkWillRemove

MapDownlinkWillRemove: function

Type declaration

    • Parameters

      Returns void

MapDownlinkWillTake

MapDownlinkWillTake: function

Type declaration

    • (upper: number, downlink: MapDownlink<K, V, KU, VU>): void
    • Parameters

      Returns void

MapDownlinkWillUpdate

MapDownlinkWillUpdate: function

Type declaration

    • (key: K, newValue: V, downlink: MapDownlink<K, V, KU, VU>): V | void
    • Parameters

      • key: K
      • newValue: V
      • downlink: MapDownlink<K, V, KU, VU>

      Returns V | void

SwimDidAuthenticate

SwimDidAuthenticate: function

Type declaration

    • (body: Value, host: Host, swim: SwimRef): void
    • Parameters

      • body: Value
      • host: Host
      • swim: SwimRef

      Returns void

SwimDidConnect

SwimDidConnect: function

Type declaration

    • (host: Host, swim: SwimRef): void
    • Parameters

      Returns void

SwimDidDeauthenticate

SwimDidDeauthenticate: function

Type declaration

    • (body: Value, host: Host, swim: SwimRef): void
    • Parameters

      • body: Value
      • host: Host
      • swim: SwimRef

      Returns void

SwimDidDisconnect

SwimDidDisconnect: function

Type declaration

    • (host: Host, swim: SwimRef): void
    • Parameters

      Returns void

SwimDidFail

SwimDidFail: function

Type declaration

    • (error: unknown, host: Host, swim: SwimRef): void
    • Parameters

      • error: unknown
      • host: Host
      • swim: SwimRef

      Returns void

ValueDownlinkWillSet

ValueDownlinkWillSet: function

Type declaration

VaueDownlinkDidSet

VaueDownlinkDidSet: function

Type declaration

    • (newValue: V, oldValue: V, downlink: ValueDownlink<V, VU>): void
    • Parameters

      Returns void

Variables

Const authenticate

authenticate: any = client.authenticate.bind(client)

Const client

client: SwimClient = new SwimClient()

Const command

command: any = client.command.bind(client)

Const downlink

downlink: any = client.downlink.bind(client)

Const downlinkList

downlinkList: any = client.downlinkList.bind(client)

Const downlinkMap

downlinkMap: any = client.downlinkMap.bind(client)

Const downlinkValue

downlinkValue: any = client.downlinkValue.bind(client)

Const hostRef

hostRef: any = client.hostRef.bind(client)

Const isOnline

isOnline: any = client.isOnline.bind(client)

Const keepOnline

keepOnline: any = client.keepOnline.bind(client)

Const laneRef

laneRef: any = client.laneRef.bind(client)

Const nodeRef

nodeRef: any = client.nodeRef.bind(client)