Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListDownlink<V, VU>

Type parameters

  • V

  • VU = never

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly context

context: DownlinkContext

Readonly flags

flags: number

Readonly model

model: null | ListDownlinkModel

Readonly observers

observers: readonly ListDownlinkObserver<V, VU>[]

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: null | STree<Value, Value>

Accessors

length

  • get length(): number

  • Returns number

session

  • Returns Value

type

  • Returns DownlinkType

Methods

body

  • Returns Value

  • Parameters

    Returns ListDownlink<V, VU>

clear

  • clear(): void

  • Returns void

close

  • close(): void

  • Returns void

closeUp

  • closeUp(): void

  • Returns void

command

  • Parameters

    Returns void

Protected copy

Protected didAliasModel

  • didAliasModel(): void

  • Returns void

didClear

  • didClear(didClear: ListDownlinkDidClear<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didClear: ListDownlinkDidClear<V, VU>

    Returns ListDownlink<V, VU>

didClose

  • Parameters

    • didClose: DownlinkDidClose

    Returns ListDownlink<V, VU>

didConnect

  • didConnect(didConnect: DownlinkDidConnect): ListDownlink<V, VU>

  • Parameters

    • didConnect: DownlinkDidConnect

    Returns ListDownlink<V, VU>

didDisconnect

  • didDisconnect(didDisconnect: DownlinkDidDisconnect): ListDownlink<V, VU>

  • Parameters

    • didDisconnect: DownlinkDidDisconnect

    Returns ListDownlink<V, VU>

didDrop

  • didDrop(didDrop: ListDownlinkDidDrop<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didDrop: ListDownlinkDidDrop<V, VU>

    Returns ListDownlink<V, VU>

didFail

  • Parameters

    • didFail: DownlinkDidFail

    Returns ListDownlink<V, VU>

didLink

  • Parameters

    • didLink: DownlinkDidLink

    Returns ListDownlink<V, VU>

didMove

  • didMove(didMove: ListDownlinkDidMove<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didMove: ListDownlinkDidMove<V, VU>

    Returns ListDownlink<V, VU>

didRemove

  • didRemove(didRemove: ListDownlinkDidRemove<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didRemove: ListDownlinkDidRemove<V, VU>

    Returns ListDownlink<V, VU>

didSync

  • Parameters

    • didSync: DownlinkDidSync

    Returns ListDownlink<V, VU>

didTake

  • didTake(didTake: ListDownlinkDidTake<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didTake: ListDownlinkDidTake<V, VU>

    Returns ListDownlink<V, VU>

didUnlink

  • didUnlink(didUnlink: DownlinkDidUnlink): ListDownlink<V, VU>

  • Parameters

    • didUnlink: DownlinkDidUnlink

    Returns ListDownlink<V, VU>

didUpdate

  • didUpdate(didUpdate: ListDownlinkDidUpdate<V, VU>): ListDownlink<V, VU>

  • Parameters

    • didUpdate: ListDownlinkDidUpdate<V, VU>

    Returns ListDownlink<V, VU>

entries

  • Returns Cursor<[Value, V]>

forEach

  • forEach<T, S>(callback: (value: V, index: number, id: Value) => void | T): undefined | T
  • forEach<T, S>(callback: (value: V, index: number, id: Value) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (value: V, index: number, id: Value) => void | T
        • (value: V, index: number, id: Value): void | T

        • Parameters

          • value: V
          • index: number
          • id: Value

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (value: V, index: number, id: Value) => void | T
        • (value: V, index: number, id: Value): void | T

        • Parameters

          • value: V
          • index: number
          • id: Value

          Returns void | T

    • thisArg: S

    Returns undefined | T

get

  • get(index: number, id?: Value): V

  • Parameters

    • index: number
    • Optional id: Value

    Returns V

getEntry

  • getEntry(index: number, id?: Value): undefined | [V, Value]

  • Parameters

    • index: number
    • Optional id: Value

    Returns undefined | [V, Value]

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 ListDownlink<V, VU>

initialState

  • Returns null | STree<Value, Value>

  • Parameters

    Returns ListDownlink<V, VU>

insert

  • Parameters

    • index: number
    • newObject: V | VU
    • Optional id: Value

    Returns ListDownlink<V, VU>

isAuthenticated

  • isAuthenticated(): boolean

  • Returns boolean

isConnected

  • isConnected(): boolean

  • Returns boolean

isEmpty

  • isEmpty(): boolean

  • Returns boolean

isLinked

  • isLinked(): boolean

  • Returns boolean

isSynced

  • isSynced(): boolean

  • Returns boolean

keepLinked

  • keepLinked(): boolean
  • keepLinked(keepLinked: boolean): ListDownlink<V, VU>

  • Returns boolean

  • Parameters

    • keepLinked: boolean

    Returns ListDownlink<V, VU>

keepSynced

  • keepSynced(): boolean
  • keepSynced(keepSynced: boolean): ListDownlink<V, VU>

  • Returns boolean

  • Parameters

    • keepSynced: boolean

    Returns ListDownlink<V, VU>

keys

  • Returns Cursor<Value>

laneUri

  • Returns Uri

  • Parameters

    Returns ListDownlink<V, VU>

listDidClear

  • listDidClear(): void

  • Returns void

listDidDrop

  • listDidDrop(lower: number): void

  • Parameters

    • lower: number

    Returns void

listDidMove

  • listDidMove(fromIndex: number, toIndex: number, value: Value): void

  • Parameters

    • fromIndex: number
    • toIndex: number
    • value: Value

    Returns void

listDidRemove

  • listDidRemove(index: number, oldValue: Value): void

  • Parameters

    • index: number
    • oldValue: Value

    Returns void

listDidTake

  • listDidTake(upper: number): void

  • Parameters

    • upper: number

    Returns void

listDidUpdate

  • listDidUpdate(index: number, newValue: Value, oldValue: Value): void

  • Parameters

    Returns void

listWillClear

  • listWillClear(): void

  • Returns void

listWillDrop

  • listWillDrop(lower: number): void

  • Parameters

    • lower: number

    Returns void

listWillMove

  • listWillMove(fromIndex: number, toIndex: number, value: Value): void

  • Parameters

    • fromIndex: number
    • toIndex: number
    • value: Value

    Returns void

listWillRemove

  • listWillRemove(index: number): void

  • Parameters

    • index: number

    Returns void

listWillTake

  • listWillTake(upper: number): void

  • Parameters

    • upper: number

    Returns void

listWillUpdate

  • listWillUpdate(index: number, newValue: Value): Value

  • Parameters

    • index: number
    • newValue: Value

    Returns Value

move

  • Parameters

    • fromIndex: number
    • toIndex: number
    • Optional id: Value

    Returns ListDownlink<V, VU>

nodeUri

  • Returns Uri

  • Parameters

    Returns ListDownlink<V, VU>

observe

onCommand

  • onCommand(onCommand: DownlinkOnCommand): ListDownlink<V, VU>

  • Parameters

    • onCommand: DownlinkOnCommand

    Returns ListDownlink<V, VU>

onCommandMessage

  • onCommandMessage(body: Value): void

  • Parameters

    Returns void

onEvent

  • Parameters

    • onEvent: DownlinkOnEvent

    Returns ListDownlink<V, VU>

onEventMessage

  • Parameters

    Returns void

onLinkRequest

  • Parameters

    Returns void

onLinkedResponse

onSyncRequest

  • Parameters

    Returns void

onSyncedResponse

onUnlinkRequest

  • Parameters

    Returns void

onUnlinkedResponse

open

  • Returns ListDownlink<V, VU>

openUp

  • openUp(host: Host): void

  • Parameters

    Returns void

pop

  • pop(): V

  • Returns V

prio

  • Returns number

  • Parameters

    • prio: number

    Returns ListDownlink<V, VU>

push

  • push(...newObjects: (V | VU)[]): number

  • Parameters

    • Rest ...newObjects: (V | VU)[]

    Returns number

rate

  • Returns number

  • Parameters

    • rate: number

    Returns ListDownlink<V, VU>

remove

  • Parameters

    • index: number
    • Optional id: Value

    Returns ListDownlink<V, VU>

set

  • Parameters

    • index: number
    • newObject: V | VU
    • Optional id: Value

    Returns ListDownlink<V, VU>

setState

  • Parameters

    Returns void

shift

  • shift(): V

  • Returns V

snapshot

  • Returns STree<Value, Value>

splice

  • splice(start: number, deleteCount?: number, ...newObjects: (V | VU)[]): V[]

  • Parameters

    • start: number
    • Optional deleteCount: number
    • Rest ...newObjects: (V | VU)[]

    Returns V[]

unobserve

  • Parameters

    • observer: unknown

    Returns ListDownlink<V, VU>

unshift

  • unshift(...newObjects: (V | VU)[]): number

  • Parameters

    • Rest ...newObjects: (V | VU)[]

    Returns number

valueForm

  • Returns Form<V, VU>

  • Type parameters

    • V2

    • V2U = never

    Parameters

    • valueForm: Form<V2, V2U>

    Returns ListDownlink<V2, V2U>

values

  • Returns Cursor<V>

willClear

  • willClear(willClear: ListDownlinkWillClear<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willClear: ListDownlinkWillClear<V, VU>

    Returns ListDownlink<V, VU>

willDrop

  • willDrop(willDrop: ListDownlinkWillDrop<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willDrop: ListDownlinkWillDrop<V, VU>

    Returns ListDownlink<V, VU>

willLink

  • Parameters

    • willLink: DownlinkWillLink

    Returns ListDownlink<V, VU>

willMove

  • willMove(willMove: ListDownlinkWillMove<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willMove: ListDownlinkWillMove<V, VU>

    Returns ListDownlink<V, VU>

willRemove

  • willRemove(willRemove: ListDownlinkWillRemove<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willRemove: ListDownlinkWillRemove<V, VU>

    Returns ListDownlink<V, VU>

willSync

  • Parameters

    • willSync: DownlinkWillSync

    Returns ListDownlink<V, VU>

willTake

  • willTake(willTake: ListDownlinkWillTake<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willTake: ListDownlinkWillTake<V, VU>

    Returns ListDownlink<V, VU>

willUnlink

  • willUnlink(willUnlink: DownlinkWillUnlink): ListDownlink<V, VU>

  • Parameters

    • willUnlink: DownlinkWillUnlink

    Returns ListDownlink<V, VU>

willUpdate

  • willUpdate(willUpdate: ListDownlinkWillUpdate<V, VU>): ListDownlink<V, VU>

  • Parameters

    • willUpdate: ListDownlinkWillUpdate<V, VU>

    Returns ListDownlink<V, VU>

Static initForm

  • Returns Form<undefined | DownlinkInit, never>

Generated using TypeDoc