Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelMapDownlink<M, K, V, KU, VU>

Type parameters

Hierarchy

Callable

  • ModelMapDownlink(key: K | KU): undefined | V
  • ModelMapDownlink(key: K | KU, value: V | VU): M

  • Parameters

    • key: K | KU

    Returns undefined | V

  • Parameters

    • key: K | KU
    • value: V | VU

    Returns M

Index

Properties

Methods

Properties

Optional consume

consume: boolean

Readonly downlink

downlink: null | MapDownlink<K, V, KU, VU>

Readonly downlinkConsumers

downlinkConsumers: readonly unknown[]

Readonly downlinkFlags

downlinkFlags: number

Readonly name

name: undefined | string

Readonly ownBody

ownBody: null | Value

Readonly ownHostUri

ownHostUri: null | Uri

ownKeyForm

ownKeyForm: null | Form<K, KU>

Readonly ownLaneUri

ownLaneUri: null | Uri

Readonly ownNodeUri

ownNodeUri: null | Uri

Readonly ownPrio

ownPrio: undefined | number

Readonly ownRate

ownRate: undefined | number

ownValueForm

ownValueForm: null | Form<V, VU>

Readonly ownWarp

ownWarp: null | WarpRef

Readonly owner

owner: M

Readonly size

size: number

Methods

addDownlinkConsumer

  • addDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

bindDownlink

  • Parameters

    Returns MapDownlink<K, V, KU, VU>

body

  • Returns null | Value

  • Parameters

    Returns ModelMapDownlink<M, K, V, KU, VU>

clear

  • clear(): void

  • Returns void

createDownlink

  • Parameters

    Returns MapDownlink<K, V, KU, VU>

delete

  • delete(key: K | KU): boolean

  • Parameters

    • key: K | KU

    Returns boolean

didAddDownlinkConsumer

  • didAddDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

didMount

  • didMount(): void

  • Returns void

didRemoveDownlinkConsumer

  • didRemoveDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

didStartConsuming

  • didStartConsuming(): void

  • Returns void

didStopConsuming

  • didStopConsuming(): void

  • Returns void

didUnmount

  • didUnmount(): void

  • Returns void

drop

  • Parameters

    • lower: number

    Returns ModelMapDownlink<M, K, V, KU, VU>

entries

  • Returns Cursor<[K, V]>

firstEntry

  • firstEntry(): undefined | [K, V]

  • Returns undefined | [K, V]

firstKey

  • firstKey(): undefined | K

  • Returns undefined | K

firstValue

  • firstValue(): undefined | V

  • Returns undefined | V

forEach

  • forEach<T>(callback: (key: K, value: V) => void | T): undefined | T
  • forEach<T, S>(callback: (key: K, value: V) => void | T, thisArg: S): undefined | T

  • Type parameters

    • T

    Parameters

    • callback: (key: K, value: V) => void | T
        • (key: K, value: V): void | T

        • Parameters

          • key: K
          • value: V

          Returns void | T

    Returns undefined | T

  • Type parameters

    • T

    • S

    Parameters

    • callback: (key: K, value: V) => void | T
        • (key: K, value: V): void | T

        • Parameters

          • key: K
          • value: V

          Returns void | T

    • thisArg: S

    Returns undefined | T

get

  • get(key: K | KU): undefined | V

  • Parameters

    • key: K | KU

    Returns undefined | V

getEntry

  • getEntry(index: number): undefined | [K, V]

  • Parameters

    • index: number

    Returns undefined | [K, V]

has

  • has(key: K | KU): boolean

  • Parameters

    • key: K | KU

    Returns boolean

hostUri

  • Returns null | Uri

  • Parameters

    Returns ModelMapDownlink<M, K, V, KU, VU>

Optional initBody

  • Returns AnyValue

Optional initDownlink

  • Parameters

    Returns MapDownlink<K, V, KU, VU>

Optional initHostUri

  • initHostUri(): null | AnyUri

  • Returns null | AnyUri

Optional initLaneUri

  • initLaneUri(): null | AnyUri

  • Returns null | AnyUri

Optional initNodeUri

  • initNodeUri(): null | AnyUri

  • Returns null | AnyUri

Optional initPrio

  • initPrio(): undefined | number

  • Returns undefined | number

Optional initRate

  • initRate(): undefined | number

  • Returns undefined | number

isConsuming

  • isConsuming(): boolean

  • Returns boolean

isEmpty

  • isEmpty(): boolean

  • Returns boolean

isMounted

  • isMounted(): boolean

  • Returns boolean

keyForm

  • Returns null | Form<K, KU>

  • Parameters

    • keyForm: null | Form<K, KU>

    Returns ModelMapDownlink<M, K, V, KU, VU>

keys

  • Returns Cursor<K>

laneUri

  • Returns null | Uri

  • Parameters

    Returns ModelMapDownlink<M, K, V, KU, VU>

lastEntry

  • lastEntry(): undefined | [K, V]

  • Returns undefined | [K, V]

lastKey

  • lastKey(): undefined | K

  • Returns undefined | K

lastValue

  • lastValue(): undefined | V

  • Returns undefined | V

link

  • link(): void

  • Returns void

mount

  • mount(): void

  • Returns void

nextEntry

  • nextEntry(keyObject: K): undefined | [K, V]

  • Parameters

    • keyObject: K

    Returns undefined | [K, V]

nextKey

  • nextKey(keyObject: K): undefined | K

  • Parameters

    • keyObject: K

    Returns undefined | K

nextValue

  • nextValue(keyObject: K): undefined | V

  • Parameters

    • keyObject: K

    Returns undefined | V

nodeUri

  • Returns null | Uri

  • Parameters

    Returns ModelMapDownlink<M, K, V, KU, VU>

onAddDownlinkConsumer

  • onAddDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

onMount

  • onMount(): void

  • Returns void

onRemoveDownlinkConsumer

  • onRemoveDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

onStartConsuming

  • onStartConsuming(): void

  • Returns void

onStopConsuming

  • onStopConsuming(): void

  • Returns void

onUnmount

  • onUnmount(): void

  • Returns void

previousEntry

  • previousEntry(keyObject: K): undefined | [K, V]

  • Parameters

    • keyObject: K

    Returns undefined | [K, V]

previousKey

  • previousKey(keyObject: K): undefined | K

  • Parameters

    • keyObject: K

    Returns undefined | K

previousValue

  • previousValue(keyObject: K): undefined | V

  • Parameters

    • keyObject: K

    Returns undefined | V

prio

  • prio(): undefined | number
  • prio(prio: undefined | number): ModelMapDownlink<M, K, V, KU, VU>

  • Returns undefined | number

  • Parameters

    • prio: undefined | number

    Returns ModelMapDownlink<M, K, V, KU, VU>

rate

  • rate(): undefined | number
  • rate(rate: undefined | number): ModelMapDownlink<M, K, V, KU, VU>

  • Returns undefined | number

  • Parameters

    • rate: undefined | number

    Returns ModelMapDownlink<M, K, V, KU, VU>

reconcile

  • reconcile(): void

  • Returns void

relink

  • relink(): void

  • Returns void

removeDownlinkConsumer

  • removeDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

set

  • Parameters

    • key: K | KU
    • newValue: V | VU

    Returns ModelMapDownlink<M, K, V, KU, VU>

setDownlinkFlags

  • setDownlinkFlags(downlinkFlags: number): void

  • Parameters

    • downlinkFlags: number

    Returns void

startConsuming

  • startConsuming(): void

  • Returns void

stopConsuming

  • stopConsuming(): void

  • Returns void

take

  • Parameters

    • upper: number

    Returns ModelMapDownlink<M, K, V, KU, VU>

unlink

  • unlink(): void

  • Returns void

unmount

  • unmount(): void

  • Returns void

valueForm

  • Returns null | Form<V, VU>

  • Parameters

    • valueForm: null | Form<V, VU>

    Returns ModelMapDownlink<M, K, V, KU, VU>

values

  • Returns Cursor<V>

warp

  • Returns null | WarpRef

  • Parameters

    Returns ModelMapDownlink<M, K, V, KU, VU>

willAddDownlinkConsumer

  • willAddDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

willMount

  • willMount(): void

  • Returns void

willRemoveDownlinkConsumer

  • willRemoveDownlinkConsumer(downlinkConsumer: unknown): void

  • Parameters

    • downlinkConsumer: unknown

    Returns void

willStartConsuming

  • willStartConsuming(): void

  • Returns void

willStopConsuming

  • willStopConsuming(): void

  • Returns void

willUnmount

  • willUnmount(): void

  • Returns void

Generated using TypeDoc