Interface WarpRef

Hierarchy

WarpDownlinkContext
- WarpRef

Index

Properties

hostUri laneUri nodeUri

Methods

authenticate command downlink downlinkList downlinkMap downlinkValue hostRef laneRef nodeRef

Properties

hostUri

hostUri: {
value: Uri;
}

Type declaration

Readonly value: Uri

laneUri

laneUri: {
value: Uri;
}

Type declaration

Readonly value: Uri

nodeUri

nodeUri: {
value: Uri;
}

Type declaration

Readonly value: Uri

Methods

authenticate

authenticate(hostUri, credentials): void
Parameters
- hostUri: UriLike
- credentials: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:20
authenticate(credentials): void
Parameters
- credentials: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:21

command

command(hostUri, nodeUri, laneUri, body): void
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:16
command(nodeUri, laneUri, body): void
Parameters
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:17
command(laneUri, body): void
Parameters
- laneUri: UriLike
- body: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:18
command(body): void
Parameters
- body: ValueLike
Returns void
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:19

downlink

downlink(template?): EventDownlink<WarpRef, any, [any]>
Parameters
- Optional template: ThisType<EventDownlink<WarpRef, any, [any]>> & EventDownlinkDescriptor<WarpRef> & Partial<Omit<EventDownlink<WarpRef, any, [any]>, keyof EventDownlinkDescriptor<WarpRef>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns EventDownlink<WarpRef, any, [any]>
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:12

downlinkList

downlinkList<V>(template?): ListDownlink<WarpRef, V, [Iterable<V>]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ListDownlink<WarpRef, V, [Iterable<V>]>> & ListDownlinkDescriptor<WarpRef, V> & Partial<Omit<ListDownlink<WarpRef, V, [Iterable<V>]>, keyof ListDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ListDownlink<WarpRef, V, [Iterable<V>]>
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:14

downlinkMap

downlinkMap<K, V>(template?): MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
Type Parameters
- K = Value
- V = Value
Parameters
- Optional template: ThisType<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>> & MapDownlinkDescriptor<WarpRef, K, V> & Partial<Omit<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>, keyof MapDownlinkDescriptor<WarpRef, K, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:15

downlinkValue

downlinkValue<V>(template?): ValueDownlink<WarpRef, V, [V]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ValueDownlink<WarpRef, V, [V]>> & ValueDownlinkDescriptor<WarpRef, V> & Partial<Omit<ValueDownlink<WarpRef, V, [V]>, keyof ValueDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ValueDownlink<WarpRef, V, [V]>
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:13

hostRef

hostRef(hostUri): WarpRef
Parameters
- hostUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:22

laneRef

laneRef(hostUri, nodeUri, laneUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:25
laneRef(nodeUri, laneUri): WarpRef
Parameters
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:26
laneRef(laneUri): WarpRef
Parameters
- laneUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:27

nodeRef

nodeRef(hostUri, nodeUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:23
nodeRef(nodeUri): WarpRef
Parameters
- nodeUri: UriLike
Returns WarpRef
- Defined in swim-host/swim-client/lib/main/WarpRef.d.ts:24

Interface WarpRef

Hierarchy

Index

Properties

Methods

Properties

hostUri

Type declaration

Readonly value: Uri

laneUri

Type declaration

Readonly value: Uri

nodeUri

Type declaration

Readonly value: Uri

Methods

authenticate

Parameters

hostUri: UriLike

credentials: ValueLike

Returns void

Parameters

credentials: ValueLike

Returns void

command

Parameters

hostUri: UriLike

nodeUri: UriLike

laneUri: UriLike

body: ValueLike

Returns void

Parameters

nodeUri: UriLike

laneUri: UriLike

body: ValueLike

Returns void

Parameters

laneUri: UriLike

body: ValueLike

Returns void

Parameters

body: ValueLike

Returns void

downlink

Parameters

Optional template: ThisType<EventDownlink<WarpRef, any, [any]>> & EventDownlinkDescriptor<WarpRef> & Partial<Omit<EventDownlink<WarpRef, any, [any]>, keyof EventDownlinkDescriptor<WarpRef>>> & { inletKeys?: readonly (keyof WarpRef)[]; }

Returns EventDownlink<WarpRef, any, [any]>

downlinkList

Type Parameters

V = Value

Parameters

Optional template: ThisType<ListDownlink<WarpRef, V, [Iterable<V>]>> & ListDownlinkDescriptor<WarpRef, V> & Partial<Omit<ListDownlink<WarpRef, V, [Iterable<V>]>, keyof ListDownlinkDescriptor<WarpRef, V>>> & { inletKeys?: readonly (keyof WarpRef)[]; }

Returns ListDownlink<WarpRef, V, [Iterable<V>]>

downlinkMap

Type Parameters

K = Value

V = Value

Parameters

Optional template: ThisType<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>> & MapDownlinkDescriptor<WarpRef, K, V> & Partial<Omit<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>, keyof MapDownlinkDescriptor<WarpRef, K, V>>> & { inletKeys?: readonly (keyof WarpRef)[]; }

Returns MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>

downlinkValue

Type Parameters

V = Value

Parameters

Optional template: ThisType<ValueDownlink<WarpRef, V, [V]>> & ValueDownlinkDescriptor<WarpRef, V> & Partial<Omit<ValueDownlink<WarpRef, V, [V]>, keyof ValueDownlinkDescriptor<WarpRef, V>>> & { inletKeys?: readonly (keyof WarpRef)[]; }

Returns ValueDownlink<WarpRef, V, [V]>

hostRef

Parameters

hostUri: UriLike

Returns WarpRef

laneRef

Parameters

hostUri: UriLike

nodeUri: UriLike

laneUri: UriLike

Returns WarpRef

Parameters

nodeUri: UriLike

laneUri: UriLike

Returns WarpRef

`Readonly` value: Uri

`Readonly` value: Uri

`Readonly` value: Uri

`Optional` template: ThisType<EventDownlink<WarpRef, any, [any]>> & EventDownlinkDescriptor<WarpRef> & Partial<Omit<EventDownlink<WarpRef, any, [any]>, keyof EventDownlinkDescriptor<WarpRef>>> & {
inletKeys?: readonly (keyof WarpRef)[];
}

`Optional` template: ThisType<ListDownlink<WarpRef, V, [Iterable<V>]>> & ListDownlinkDescriptor<WarpRef, V> & Partial<Omit<ListDownlink<WarpRef, V, [Iterable<V>]>, keyof ListDownlinkDescriptor<WarpRef, V>>> & {
inletKeys?: readonly (keyof WarpRef)[];
}

`Optional` template: ThisType<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>> & MapDownlinkDescriptor<WarpRef, K, V> & Partial<Omit<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>, keyof MapDownlinkDescriptor<WarpRef, K, V>>> & {
inletKeys?: readonly (keyof WarpRef)[];
}

`Optional` template: ThisType<ValueDownlink<WarpRef, V, [V]>> & ValueDownlinkDescriptor<WarpRef, V> & Partial<Omit<ValueDownlink<WarpRef, V, [V]>, keyof ValueDownlinkDescriptor<WarpRef, V>>> & {
inletKeys?: readonly (keyof WarpRef)[];
}