Class WarpClient

Hierarchy

WarpScope
- WarpClient

Index

Constructors

Accessors

componentType insertChildFlags inserting mountFlags mounted reinsertChildFlags removeChildFlags removing

Methods

appendChild attachFastener authenticate bindFastener callObservers closeHost command commonAncestor createHost decohereFastener didAttachParent didDetachParent didInsertChild didMount didObserve didReinsertChild didRemoveChild didUnmount didUnobserve downlink downlinkList downlinkMap downlinkValue enqueueFastener equals forEachChild getAncestor getChild getFastener getFirstChild getHost getLastChild getNextSibling getParentFastener getPreviousSibling getRoot getTargetChild hashCode hostRef insertChild isAncestorOf laneRef likeType? mount nodeRef observe onAttachParent onDetachParent onInsertChild onMount onObserve onReinsertChild onRemoveChild onUnmount onUnobserve openHost prependChild recohereFasteners reinsertChild remove removeChild removeChildren replaceChild requireUpdate set setChild setIntrinsic sortChildren tryFastener unmount unobserve willAttachParent willDetachParent willInsertChild willMount willObserve willReinsertChild willRemoveChild willUnmount willUnobserve create fromLike global

Constructors

constructor

new WarpClient(): WarpClient
Returns WarpClient
Overrides WarpScope.constructor
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:23

Properties

`Readonly` firstChild

firstChild: Component<any>

`Readonly` hostUri

hostUri: Property<WarpClient, Uri, [Uri]>

`Readonly` idleTimeout

idleTimeout: Property<WarpClient, number, [number]>

`Readonly` key

key: string

`Readonly` laneUri

laneUri: Property<WarpClient, Uri, [Uri]>

`Readonly` lastChild

lastChild: Component<any>

`Readonly` maxReconnectTimeout

maxReconnectTimeout: Property<WarpClient, number, [number]>

`Readonly` nextSibling

nextSibling: Component<any>

`Readonly` nodeUri

nodeUri: Property<WarpClient, Uri, [Uri]>

`Optional` `Readonly` observerType

observerType?: Class<WarpClientObserver<WarpClient>>

`Readonly` online

online: Property<WarpClient, boolean, [boolean]> & Property<WarpScope, boolean, [boolean]>

`Readonly` parent

parent: Component<any>

`Readonly` previousSibling

previousSibling: Component<any>

`Readonly` sendBufferSize

sendBufferSize: Property<WarpClient, number, [number]>

`Readonly` unlinkDelay

unlinkDelay: Property<WarpClient, number, [number]>

`Readonly` warpRef

warpRef: Property<WarpClient, WarpRef, [WarpRef]>

`Readonly` workerUrl

workerUrl: Property<WarpClient, string, [string]>

`Readonly` wsConstructor

wsConstructor: Property<WarpClient, {
    CLOSED: 3;
    CLOSING: 2;
    CONNECTING: 0;
    OPEN: 1;
    prototype: WebSocket;
    new (url, protocols?): WebSocket;
}, [{
    CLOSED: 3;
    CLOSING: 2;
    CONNECTING: 0;
    OPEN: 1;
    prototype: WebSocket;
    new (url, protocols?): WebSocket;
}]>

Type declaration

- new (url, protocols?): WebSocket
- Parameters
  - url: string | URL
  - Optional protocols: string | string[]
  Returns WebSocket
Readonly CLOSED: 3
Readonly CLOSING: 2
Readonly CONNECTING: 0
Readonly OPEN: 1
prototype: WebSocket

`Readonly` wsProtocols

wsProtocols: Property<WarpClient, string | readonly string[], [string | readonly string[]]>

`Static` `Readonly` InsertChildFlags

InsertChildFlags: number

`Static` `Readonly` MountFlags

MountFlags: number

`Static` `Readonly` ReinsertChildFlags

ReinsertChildFlags: number

`Static` `Readonly` RemoveChildFlags

RemoveChildFlags: number

Accessors

componentType

get componentType(): Class<Component<Component<any>>>
Returns Class<Component<Component<any>>>
Inherited from WarpScope.componentType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:131

insertChildFlags

get insertChildFlags(): number
Returns number
Inherited from WarpScope.insertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:198

inserting

get inserting(): boolean
Returns boolean
Inherited from WarpScope.inserting
- Defined in swim-core/swim-component/dist/swim-component.d.ts:199

mountFlags

get mountFlags(): number
Returns number
Inherited from WarpScope.mountFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:229

mounted

get mounted(): boolean
Returns boolean
Inherited from WarpScope.mounted
- Defined in swim-core/swim-component/dist/swim-component.d.ts:228

reinsertChildFlags

get reinsertChildFlags(): number
Returns number
Inherited from WarpScope.reinsertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:215

removeChildFlags

get removeChildFlags(): number
Returns number
Inherited from WarpScope.removeChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:208

removing

get removing(): boolean
Returns boolean
Inherited from WarpScope.removing
- Defined in swim-core/swim-component/dist/swim-component.d.ts:209

Methods

appendChild

appendChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from WarpScope.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:186
appendChild<Child>(child, key?): Child
Type Parameters
- Child extends Component<any>
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from WarpScope.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:187
appendChild(child, key?): Component<any>
Parameters
- child: Component<any> | {
  create?() => any;
  }
- Optional key: string
Returns Component<any>
Inherited from WarpScope.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:188

attachFastener

attachFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpScope.attachFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:252

authenticate

authenticate(hostUri, credentials): void
Parameters
- hostUri: UriLike
- credentials: ValueLike
Returns void
Overrides WarpScope.authenticate
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:29
authenticate(credentials): void
Parameters
- credentials: ValueLike
Returns void
Overrides WarpScope.authenticate
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:30

`Protected` bindFastener

bindFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpScope.bindFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:257

callObservers

callObservers<O, K>(this, key, ...args): void
Type Parameters
- O
- K extends string | number | symbol
Parameters
- this: {
  observerType?: Class<O>;
  }
  - Optional Readonly observerType?: Class<O>
- key: K
- Rest ...args: ObserverParameters<O, K>
Returns void
Inherited from WarpScope.callObservers
- Defined in swim-core/swim-component/dist/swim-component.d.ts:302

closeHost

closeHost(hostUri): WarpHost
Parameters
- hostUri: UriLike
Returns WarpHost
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:38

command

command(hostUri, nodeUri, laneUri, body): void
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Overrides WarpScope.command
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:25
command(nodeUri, laneUri, body): void
Parameters
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Overrides WarpScope.command
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:26
command(laneUri, body): void
Parameters
- laneUri: UriLike
- body: ValueLike
Returns void
Overrides WarpScope.command
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:27
command(body): void
Parameters
- body: ValueLike
Returns void
Overrides WarpScope.command
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:28

commonAncestor

commonAncestor(relative): Component<any>
Parameters
- relative: Component<any>
Returns Component<any>
Inherited from WarpScope.commonAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:227

`Protected` createHost

createHost(hostUri): WarpHost
Parameters
- hostUri: Uri
Returns WarpHost
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:37

decohereFastener

decohereFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpScope.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:287

`Protected` didAttachParent

didAttachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.didAttachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:146

`Protected` didDetachParent

didDetachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.didDetachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:151

`Protected` didInsertChild

didInsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.didInsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:202

`Protected` didMount

didMount(): void
Returns void
Inherited from WarpScope.didMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:235

`Protected` didObserve

didObserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.didObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:296

`Protected` didReinsertChild

didReinsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.didReinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:219

`Protected` didRemoveChild

didRemoveChild(child): void
Parameters
- child: Component<any>
Returns void
Inherited from WarpScope.didRemoveChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:212

`Protected` didUnmount

didUnmount(): void
Returns void
Inherited from WarpScope.didUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:243

`Protected` didUnobserve

didUnobserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.didUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:301

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]>
Inherited from WarpScope.downlink
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:23

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>]>
Inherited from WarpScope.downlinkList
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:27

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]>]>
Inherited from WarpScope.downlinkMap
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:29

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]>
Inherited from WarpScope.downlinkValue
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:25

`Protected` enqueueFastener

enqueueFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from WarpScope.enqueueFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:288

equals

equals(that): boolean
Parameters
- that: unknown
Returns boolean
Inherited from WarpScope.equals
- Defined in swim-core/swim-component/dist/swim-component.d.ts:306

forEachChild

forEachChild<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((child) => void | T)
  - - (child): void | T
    - Parameters
      
      child: Component<any>
      
      Returns void | T
Returns T
Inherited from WarpScope.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:174
forEachChild<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, child) => void | T)
  - - (this, child): void | T
    - Parameters
      
      this: S
      
      child: Component<any>
      
      Returns void | T
- thisArg: S
Returns T
Inherited from WarpScope.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:175

getAncestor

getAncestor<F>(ancestorType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- ancestorType: F
Returns InstanceType<F>
Inherited from WarpScope.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:222
getAncestor(ancestorType): Component<any>
Parameters
- ancestorType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:223

getChild

getChild<F>(key, childType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- key: string
- childType: F
Returns InstanceType<F>
Inherited from WarpScope.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:182
getChild(key, childType?): Component<any>
Parameters
- key: string
- Optional childType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:183

getFastener

getFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, any>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from WarpScope.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:248

getFirstChild

getFirstChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from WarpScope.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:165
getFirstChild(childType): Component<any>
Parameters
- childType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:166

getHost

getHost(hostUri): WarpHost
Parameters
- hostUri: UriLike
Returns WarpHost
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:35

getLastChild

getLastChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from WarpScope.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:170
getLastChild(childType): Component<any>
Parameters
- childType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:171

getNextSibling

getNextSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from WarpScope.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:155
getNextSibling(siblingType): Component<any>
Parameters
- siblingType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:156

getParentFastener

getParentFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, any>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from WarpScope.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:250

getPreviousSibling

getPreviousSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from WarpScope.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:160
getPreviousSibling(siblingType): Component<any>
Parameters
- siblingType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:161

getRoot

getRoot<F>(rootType): InstanceType<F>
Type Parameters
- F extends Class<Component<any>>
Parameters
- rootType: F
Returns InstanceType<F>
Inherited from WarpScope.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:224
getRoot(rootType): Component<any>
Parameters
- rootType: Class<Component<any>>
Returns Component<any>
Inherited from WarpScope.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:225

getTargetChild

getTargetChild(child, comparator): Component<any>
Parameters
- child: Component<any>
- comparator: Comparator<Component<any>>
Returns Component<any>
Inherited from WarpScope.getTargetChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:221

hashCode

hashCode(): number
Returns number
Inherited from WarpScope.hashCode
- Defined in swim-core/swim-component/dist/swim-component.d.ts:308

hostRef

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

insertChild

insertChild<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>
Parameters
- childFactory: F
- target: Component<any>
- Optional key: string
Returns InstanceType<F>
Inherited from WarpScope.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:192
insertChild<Child>(child, target, key?): Child
Type Parameters
- Child extends Component<any>
Parameters
- child: Child | LikeType<Child>
- target: Component<any>
- Optional key: string
Returns Child
Inherited from WarpScope.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:193
insertChild(child, target, key?): Component<any>
Parameters
- child: Component<any> | {
  create?() => any;
  }
- target: Component<any>
- Optional key: string
Returns Component<any>
Inherited from WarpScope.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:194

isAncestorOf

isAncestorOf(descendant): boolean
Parameters
- descendant: Component<any>
Returns boolean
Inherited from WarpScope.isAncestorOf
- Defined in swim-core/swim-component/dist/swim-component.d.ts:226

laneRef

laneRef(hostUri, nodeUri, laneUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Inherited from WarpScope.laneRef
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:49
laneRef(nodeUri, laneUri): WarpRef
Parameters
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Inherited from WarpScope.laneRef
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:51
laneRef(laneUri): WarpRef
Parameters
- laneUri: UriLike
Returns WarpRef
Inherited from WarpScope.laneRef
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:53

`Optional` likeType

likeType(like): void
Parameters
- like: {
  create?() => Component<any>;
  }
  - create?:function
    - create(): Component<any>
    - Returns Component<any>
      
      Defined in swim-core/swim-component/dist/swim-component.d.ts:127
Returns void
Inherited from WarpScope.likeType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:126

mount

mount(): void
Returns void
Inherited from WarpScope.mount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:230

nodeRef

nodeRef(hostUri, nodeUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
Returns WarpRef
Inherited from WarpScope.nodeRef
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:45
nodeRef(nodeUri): WarpRef
Parameters
- nodeUri: UriLike
Returns WarpRef
Inherited from WarpScope.nodeRef
- Defined in swim-host/swim-client/lib/main/WarpScope.d.ts:47

observe

observe(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.observe
- Defined in swim-core/swim-component/dist/swim-component.d.ts:293

`Protected` onAttachParent

onAttachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.onAttachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:145

`Protected` onDetachParent

onDetachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.onDetachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:150

`Protected` onInsertChild

onInsertChild(child, target): void
Parameters
- child: Component<Component<any>>
- target: Component<Component<any>>
Returns void
Overrides WarpScope.onInsertChild
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:56

`Protected` onMount

onMount(): void
Returns void
Overrides WarpScope.onMount
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:68

`Protected` onObserve

onObserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.onObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:295

`Protected` onReinsertChild

onReinsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.onReinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:218

`Protected` onRemoveChild

onRemoveChild(child): void
Parameters
- child: Component<Component<any>>
Returns void
Overrides WarpScope.onRemoveChild
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:59

`Protected` onUnmount

onUnmount(): void
Returns void
Overrides WarpScope.onUnmount
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:69

`Protected` onUnobserve

onUnobserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.onUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:300

openHost

openHost(hostUri): WarpHost
Parameters
- hostUri: UriLike
Returns WarpHost
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:36

prependChild

prependChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from WarpScope.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:189
prependChild<Child>(child, key?): Child
Type Parameters
- Child extends Component<any>
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from WarpScope.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:190
prependChild(child, key?): Component<any>
Parameters
- child: Component<any> | {
  create?() => any;
  }
- Optional key: string
Returns Component<any>
Inherited from WarpScope.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:191

recohereFasteners

recohereFasteners(t?): void
Parameters
- Optional t: number
Returns void
Inherited from WarpScope.recohereFasteners
- Defined in swim-core/swim-component/dist/swim-component.d.ts:289

reinsertChild

reinsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.reinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:216

remove

remove(): void
Returns void
Inherited from WarpScope.remove
- Defined in swim-core/swim-component/dist/swim-component.d.ts:214

removeChild

removeChild<Child>(child): Child
Type Parameters
- Child extends Component<any>
Parameters
- child: Child
Returns Child
Inherited from WarpScope.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:205
removeChild(child): Component<any>
Parameters
- child: Component<any>
Returns Component<any>
Inherited from WarpScope.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:206
removeChild(key): Component<any>
Parameters
- key: string | Component<any>
Returns Component<any>
Inherited from WarpScope.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:207

removeChildren

removeChildren(): void
Returns void
Inherited from WarpScope.removeChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:213

replaceChild

replaceChild<F>(newChildFactory, oldChild): Component<any>
Type Parameters
- F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>
Parameters
- newChildFactory: F
- oldChild: Component<any>
Returns Component<any>
Inherited from WarpScope.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:195
replaceChild<Child>(newChild, oldChild): Child
Type Parameters
- Child extends Component<any>
Parameters
- newChild: Component<any> | {
  create?() => any;
  }
- oldChild: Child
Returns Child
Inherited from WarpScope.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:196
replaceChild(newChild, oldChild): Component<any>
Parameters
- newChild: Component<any> | {
  create?() => any;
  }
- oldChild: Component<any>
Returns Component<any>
Inherited from WarpScope.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:197

requireUpdate

requireUpdate(updateFlags, immediate?): void
Parameters
- updateFlags: number
- Optional immediate: boolean
Returns void
Inherited from WarpScope.requireUpdate
- Defined in swim-core/swim-component/dist/swim-component.d.ts:246

set

set<S>(this, properties, timing?): WarpClient
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              set(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              set(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns WarpClient
Inherited from WarpScope.set
- Defined in swim-core/swim-component/dist/swim-component.d.ts:266

setChild

setChild<F>(key, newChildFactory): Component<any>
Type Parameters
- F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>
Parameters
- key: string
- newChildFactory: F
Returns Component<any>
Inherited from WarpScope.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:184
setChild(key, newChild): Component<any>
Parameters
- key: string
- newChild: Component<any> | {
  create?() => any;
  }
Returns Component<any>
Inherited from WarpScope.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:185

setIntrinsic

setIntrinsic<S>(this, properties, timing?): WarpClient
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              setIntrinsic(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              setIntrinsic(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns WarpClient
Inherited from WarpScope.setIntrinsic
- Defined in swim-core/swim-component/dist/swim-component.d.ts:273

sortChildren

sortChildren(comparator): void
Parameters
- comparator: Comparator<Component<any>>
Returns void
Inherited from WarpScope.sortChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:220

tryFastener

tryFastener<K, F>(fastenerName): F extends Fastener<any, any, any>
? F
: never
Type Parameters
- K extends keyof WarpClient
- F extends string | number | boolean | readonly Fastener<any, any, any>[] | Component<any> | Class<Component<Component<any>>> | {} | {} | {} | (() => void) | (() => void) | (() => void) | {} | (() => void) | {} | ((updateFlags, immediate?) => void) | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | ((t?) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | ((like) => void) | {} | {} | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Component<any>;
  } | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Component<any>;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Component<any>;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Component<any>;
  } | {} | {
      <T>(callback): T;
      <T, S>(callback, thisArg): T;
  } | Dictionary<Component<any>> | {
      <F>(key, childType): InstanceType<F>;
      (key, childType?): Component<any>;
  } | {
      <F>(key, newChildFactory): Component<any>;
      (key, newChild): Component<any>;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Component<any>;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Component<any>;
  } | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <Child>(child, target, key?): Child;
      (child, target, key?): Component<any>;
  } | {
      <F>(newChildFactory, oldChild): Component<any>;
      <Child>(newChild, oldChild): Child;
      (newChild, oldChild): Component<any>;
  } | {
      <Child>(child): Child;
      (child): Component<any>;
      (key): Component<any>;
  } | ((child, target) => void) | ((comparator) => void) | ((child, comparator) => Component<any>) | {
      <F>(ancestorType): InstanceType<F>;
      (ancestorType): Component<any>;
  } | {
      <F>(rootType): InstanceType<F>;
      (rootType): Component<any>;
  } | ((descendant) => boolean) | ((relative) => Component<any>) | ((template?) => EventDownlink<WarpRef, any, [any]>) | (<V>(template?) => ValueDownlink<WarpRef, V, [V]>) | (<V>(template?) => ListDownlink<WarpRef, V, [Iterable<V>]>) | (<K, V>(template?) => MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>) | ((hostUri) => WarpRef) | {
      (hostUri, nodeUri): WarpRef;
      (nodeUri): WarpRef;
  } | {
      (hostUri, nodeUri, laneUri): WarpRef;
      (nodeUri, laneUri): WarpRef;
      (laneUri): WarpRef;
  } | {
      (hostUri, nodeUri, laneUri, body): void;
      (nodeUri, laneUri, body): void;
      (laneUri, body): void;
      (body): void;
  } | {
      (hostUri, credentials): void;
      (credentials): void;
  } | {} | {} | Class<WarpClientObserver<WarpClient>> | ((hostUri) => WarpHost) | ((hostUri) => WarpHost) | ((hostUri) => WarpHost) | Property<WarpClient, number, [number]> | Property<WarpClient, {
      CLOSED: 3;
      CLOSING: 2;
      CONNECTING: 0;
      OPEN: 1;
      prototype: WebSocket;
      new (url, protocols?): WebSocket;
  }, [{
      CLOSED: 3;
      CLOSING: 2;
      CONNECTING: 0;
      OPEN: 1;
      prototype: WebSocket;
      new (url, protocols?): WebSocket;
  }]> | Property<WarpClient, string | readonly string[], [string | readonly string[]]> | Property<WarpClient, string, [string]> | {} | {} | {} | {} | {} | Property<WarpClient, WarpRef, [WarpRef]> | Property<WarpClient, boolean, [boolean]> & Property<WarpScope, boolean, [boolean]> | Property<WarpClient, Uri, [Uri]> | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
      ? F
      : never) | (<S>(this, properties, timing?) => WarpClient) | ReadonlySet<WarpClientObserver<WarpClient>> | ((observer) => void) | ((observer) => void) | (<S>(this, properties, timing?) => WarpClient) = WarpClient[K]
Parameters
- fastenerName: K
Returns F extends Fastener<any, any, any>
? F
: never
Inherited from WarpScope.tryFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:247

unmount

unmount(): void
Returns void
Inherited from WarpScope.unmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:238

unobserve

unobserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.unobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:298

`Protected` willAttachParent

willAttachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.willAttachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:144

`Protected` willDetachParent

willDetachParent(parent): void
Parameters
- parent: Component<any>
Returns void
Inherited from WarpScope.willDetachParent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:149

`Protected` willInsertChild

willInsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.willInsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:200

`Protected` willMount

willMount(): void
Returns void
Inherited from WarpScope.willMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:233

`Protected` willObserve

willObserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.willObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:294

`Protected` willReinsertChild

willReinsertChild(child, target): void
Parameters
- child: Component<any>
- target: Component<any>
Returns void
Inherited from WarpScope.willReinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:217

`Protected` willRemoveChild

willRemoveChild(child): void
Parameters
- child: Component<any>
Returns void
Inherited from WarpScope.willRemoveChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:210

`Protected` willUnmount

willUnmount(): void
Returns void
Inherited from WarpScope.willUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:241

`Protected` willUnobserve

willUnobserve(observer): void
Parameters
- observer: WarpClientObserver<WarpClient>
Returns void
Inherited from WarpScope.willUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:299

`Static` create

create<S>(this): InstanceType<S>
Type Parameters
- S extends (new () => InstanceType<S>)
Parameters
- this: S
Returns InstanceType<S>
Inherited from WarpScope.create
- Defined in swim-core/swim-component/dist/swim-component.d.ts:309

`Static` fromLike

fromLike<S>(this, value): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, Component<Component<any>>>>
Parameters
- this: S
- value: InstanceType<S> | LikeType<InstanceType<S>>
Returns InstanceType<S>
Inherited from WarpScope.fromLike
- Defined in swim-core/swim-component/dist/swim-component.d.ts:310

`Static` global

global(): WarpClient
Returns WarpClient
- Defined in swim-host/swim-client/lib/main/WarpClient.d.ts:70

Class WarpClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WarpClient

Properties

Readonly firstChild

Readonly hostUri

Readonly idleTimeout

Readonly key

Readonly laneUri

Readonly lastChild

Readonly maxReconnectTimeout

Readonly nextSibling

Readonly nodeUri

Optional Readonly observerType

Readonly online

Readonly parent

Readonly previousSibling

Readonly sendBufferSize

Readonly unlinkDelay

Readonly warpRef

Readonly workerUrl

Readonly wsConstructor

Type declaration

Parameters

url: string | URL

Optional protocols: string | string[]

Returns WebSocket

Readonly CLOSED: 3

Readonly CLOSING: 2

Readonly CONNECTING: 0

Readonly OPEN: 1

prototype: WebSocket

Readonly wsProtocols

Static Readonly InsertChildFlags

Static Readonly MountFlags

Static Readonly ReinsertChildFlags

Static Readonly RemoveChildFlags

Accessors

componentType

Returns Class<Component<Component<any>>>

insertChildFlags

Returns number

inserting

Returns boolean

mountFlags

Returns number

mounted

Returns boolean

reinsertChildFlags

Returns number

removeChildFlags

Returns number

removing

Returns boolean

Methods

appendChild

Type Parameters

F extends Class<Instance<F, Component<any>>> & Creatable<Instance<F, Component<any>>>

Parameters

childFactory: F

Optional key: string

Returns InstanceType<F>

Type Parameters

Child extends Component<any>

Parameters

child: Child | LikeType<Child>

Optional key: string

Returns Child

Parameters

child: Component<any> | { create?() => any; }

Optional key: string

Returns Component<any>

attachFastener

`Readonly` firstChild

`Readonly` hostUri

`Readonly` idleTimeout

`Readonly` key

`Readonly` laneUri

`Readonly` lastChild

`Readonly` maxReconnectTimeout

`Readonly` nextSibling

`Readonly` nodeUri

`Optional` `Readonly` observerType

`Readonly` online

`Readonly` parent

`Readonly` previousSibling

`Readonly` sendBufferSize

`Readonly` unlinkDelay

`Readonly` warpRef

`Readonly` workerUrl

`Readonly` wsConstructor

`Optional` protocols: string | string[]

`Readonly` CLOSED: 3

`Readonly` CLOSING: 2

`Readonly` CONNECTING: 0

`Readonly` OPEN: 1

`Readonly` wsProtocols

`Static` `Readonly` InsertChildFlags

`Static` `Readonly` MountFlags

`Static` `Readonly` ReinsertChildFlags

`Static` `Readonly` RemoveChildFlags

`Optional` key: string

`Optional` key: string

child: Component<any> | {
create?() => any;
}

`Optional` key: string

`Protected` bindFastener

this: {
observerType?: Class<O>;
}

`Optional` `Readonly` observerType?: Class<O>

`Rest` ...args: ObserverParameters<O, K>

`Protected` createHost

`Protected` didAttachParent

`Protected` didDetachParent

`Protected` didInsertChild