Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ValueDownlink<V, VU>

Type parameters

  • V

  • VU = never

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly context

Readonly flags

flags: number

Readonly input

input: null | Outlet<V>

Readonly model

model: null | ValueDownlinkModel

observers

observers: readonly ValueDownlinkObserver<V, VU>[]

Readonly outputs

outputs: readonly Inlet<V>[]

Readonly ownBody

ownBody: Value

Readonly ownHostUri

ownHostUri: Uri

Readonly ownLaneUri

ownLaneUri: Uri

Readonly ownNodeUri

ownNodeUri: Uri

Readonly ownPrio

ownPrio: number

Readonly ownRate

ownRate: number

Readonly ownValueForm

ownValueForm: Form<V, VU>

Readonly owner

owner: null | DownlinkOwner

Readonly state0

state0: Value

Readonly version

version: number

Accessors

session

  • Returns Value

type

  • Returns DownlinkType

Methods

bindInput

  • bindInput(newInput: null | Outlet<V>): void
  • Parameters

    Returns void

bindOutput

  • bindOutput(output: Inlet<V>): void
  • Parameters

    Returns void

body

  • Returns Value

  • Parameters

    Returns ValueDownlink<V, VU>

close

  • close(): void
  • Returns void

closeUp

  • closeUp(): void
  • Returns void

command

  • Parameters

    Returns void

Protected copy

decohere

  • decohere(): void
  • Returns void

decohereInput

  • decohereInput(): void
  • Returns void

decohereOutput

  • decohereOutput(): void
  • Returns void

Protected didAliasModel

  • didAliasModel(): void
  • Returns void

didClose

  • Parameters

    • didClose: DownlinkDidClose

    Returns ValueDownlink<V, VU>

didConnect

  • didConnect(didConnect: DownlinkDidConnect): ValueDownlink<V, VU>
  • Parameters

    • didConnect: DownlinkDidConnect

    Returns ValueDownlink<V, VU>

Protected didDecohere

  • didDecohere(): void
  • Returns void

didDisconnect

  • didDisconnect(didDisconnect: DownlinkDidDisconnect): ValueDownlink<V, VU>
  • Parameters

    • didDisconnect: DownlinkDidDisconnect

    Returns ValueDownlink<V, VU>

didFail

  • Parameters

    • didFail: DownlinkDidFail

    Returns ValueDownlink<V, VU>

didLink

  • Parameters

    • didLink: DownlinkDidLink

    Returns ValueDownlink<V, VU>

Protected didRecohere

  • didRecohere(version: number): void
  • Parameters

    • version: number

    Returns void

didSet

  • didSet(didSet: VaueDownlinkDidSet<V, VU>): ValueDownlink<V, VU>
  • Parameters

    • didSet: VaueDownlinkDidSet<V, VU>

    Returns ValueDownlink<V, VU>

didSync

  • Parameters

    • didSync: DownlinkDidSync

    Returns ValueDownlink<V, VU>

didUnlink

  • Parameters

    • didUnlink: DownlinkDidUnlink

    Returns ValueDownlink<V, VU>

disconnectInputs

  • disconnectInputs(): void
  • Returns void

disconnectOutputs

  • disconnectOutputs(): void
  • Returns void

get

  • get(): V
  • Returns V

hostDidConnect

  • hostDidConnect(): void
  • Returns void

hostDidDisconnect

  • hostDidDisconnect(): void
  • Returns void

hostDidFail

  • hostDidFail(error: unknown): void
  • Parameters

    • error: unknown

    Returns void

hostUri

  • Returns Uri

  • Parameters

    Returns ValueDownlink<V, VU>

initialState

  • Returns Value

  • Parameters

    Returns ValueDownlink<V, VU>

isAuthenticated

  • isAuthenticated(): boolean
  • Returns boolean

isConnected

  • isConnected(): boolean
  • Returns boolean

isLinked

  • isLinked(): boolean
  • Returns boolean

isSynced

  • isSynced(): boolean
  • Returns boolean

keepLinked

  • keepLinked(): boolean
  • keepLinked(keepLinked: boolean): ValueDownlink<V, VU>
  • Returns boolean

  • Parameters

    • keepLinked: boolean

    Returns ValueDownlink<V, VU>

keepSynced

  • keepSynced(): boolean
  • keepSynced(keepSynced: boolean): ValueDownlink<V, VU>
  • Returns boolean

  • Parameters

    • keepSynced: boolean

    Returns ValueDownlink<V, VU>

laneUri

  • Returns Uri

  • Parameters

    Returns ValueDownlink<V, VU>

map

  • Type parameters

    • O2

    Parameters

    Returns Outlet<O2>

memoize

  • Returns Outlet<V>

nodeUri

  • Returns Uri

  • Parameters

    Returns ValueDownlink<V, VU>

observe

onCommand

  • Parameters

    • onCommand: DownlinkOnCommand

    Returns ValueDownlink<V, VU>

onCommandMessage

  • onCommandMessage(body: Value): void
  • Parameters

    Returns void

Protected onDecohere

  • onDecohere(): void
  • Returns void

onEvent

  • Parameters

    • onEvent: DownlinkOnEvent

    Returns ValueDownlink<V, VU>

onEventMessage

  • Parameters

    Returns void

onLinkRequest

  • Parameters

    Returns void

onLinkedResponse

Protected onRecohere

  • onRecohere(version: number): void
  • Parameters

    • version: number

    Returns void

onSyncRequest

  • Parameters

    Returns void

onSyncedResponse

onUnlinkRequest

  • Parameters

    Returns void

onUnlinkedResponse

open

  • Returns ValueDownlink<V, VU>

openUp

  • openUp(host: Host): void
  • Parameters

    Returns void

outputIterator

  • Returns Cursor<Inlet<V>>

prio

  • Returns number

  • Parameters

    • prio: number

    Returns ValueDownlink<V, VU>

rate

  • Returns number

  • Parameters

    • rate: number

    Returns ValueDownlink<V, VU>

recohere

  • recohere(version: number): void
  • Parameters

    • version: number

    Returns void

recohereInput

  • recohereInput(version: number): void
  • Parameters

    • version: number

    Returns void

recohereOutput

  • recohereOutput(version: number): void
  • Parameters

    • version: number

    Returns void

set

  • set(newObject: V | VU): void
  • Parameters

    • newObject: V | VU

    Returns void

setState

  • setState(state: Value): void
  • Parameters

    Returns void

unbindInput

  • unbindInput(): void
  • Returns void

unbindOutput

  • unbindOutput(output: Inlet<V>): void
  • Parameters

    Returns void

unbindOutputs

  • unbindOutputs(): void
  • Returns void

unobserve

  • Parameters

    • observer: unknown

    Returns ValueDownlink<V, VU>

valueDidSet

  • valueDidSet(newValue: Value, oldValue: Value): void
  • Parameters

    Returns void

valueForm

  • Returns Form<V, VU>

  • Type parameters

    • V2

    • V2U = never

    Parameters

    • valueForm: Form<V2, V2U>

    Returns ValueDownlink<V2, V2U>

valueWillSet

  • Parameters

    Returns Value

watch

  • Parameters

    Returns ValueDownlink<V, VU>

Protected willDecohere

  • willDecohere(): void
  • Returns void

willLink

  • Parameters

    • willLink: DownlinkWillLink

    Returns ValueDownlink<V, VU>

Protected willRecohere

  • willRecohere(version: number): void
  • Parameters

    • version: number

    Returns void

willSet

  • willSet(willSet: ValueDownlinkWillSet<V, VU>): ValueDownlink<V, VU>
  • Parameters

    • willSet: ValueDownlinkWillSet<V, VU>

    Returns ValueDownlink<V, VU>

willSync

  • Parameters

    • willSync: DownlinkWillSync

    Returns ValueDownlink<V, VU>

willUnlink

  • willUnlink(willUnlink: DownlinkWillUnlink): ValueDownlink<V, VU>
  • Parameters

    • willUnlink: DownlinkWillUnlink

    Returns ValueDownlink<V, VU>

Static initForm

  • Returns Form<undefined | DownlinkInit, never>

Generated using TypeDoc