swim-client-js
Advanced tools
The Swim JavaScript client makes it easy to build web apps that connect seamlessly to ultra responsive, highly scalable Swim services running in the cloud.
To get started writing reactive Swim services, check out the SwimJS server runtime.
The Swim client library can run in any standard JavaScript environment.
Use npm to incorporate the library into Node.js projects.
npm install --save swim-client-js
var swim = require('swim-client-js');
The exported library module is also global Client instance.
Scripts can use the global swim client to keep simple things simple.
var swim = require('swim-client-js');
var users = swim.syncMap('ws://swim.example.com/chat/public', 'chat/users');
Returns a Client object, which represents a dedicated connection pool.
options.maxReconnectTimeout: maximum number of milliseconds to wait between
reconnect attempts after exponential backoff. Defaults to 30 seconds.options.idleTimeout: number of milliseconds to wait before closing a
connection with no active links. Defaults to 1 second.options.sendBufferSize: maximum number of commands to buffer while waiting
for the network. Defaults to 1,024 messages.var swim = require('swim-client-js');
var client = swim.client();
Authorizes all connections to hostUri through client with the provided
credentials object. credentials might contain, for example, a
Google Sign-In ID token.
Note that connections to public hosts may not require authorization.
Returns a new DownlinkBuilder, used to establish a new link to a lane of some remote node.
Returns a Downlink to a lane of a remote node. If provided,
hostUri specifies the network endpoint to connect to, otherwise nodeUri
must include a network authority component. The returned Downlink will
receive events as they're published on the linked lane of the remote node.
options.prio: the desired priority of events on the link. A priority is
a floating point ranging value between -1.0 and 1.0, with -1.0 being
the lowest priority, 1.0 being the highest priority, and 0.0 being the
default priority. Events with higher priority are sent to the client before
events with lower priority.options.keepAlive: whether or not to automatically re-establish the link
after connection failures. Defaults to false.Returns a synchronized Downlink to a lane of a remote node. If
provided, hostUri specifies the network endpoint to connect to, otherwise
nodeUri must include a network authority component. The returned Downlink
will receive a dump of all events representing the current state of the linked
lane, and will continue receiving additional events as they're published.
options.prio: the desired priority of events on the link. A priority is
a floating point ranging value between -1.0 and 1.0, with -1.0 being
the lowest priority, 1.0 being the highest priority, and 0.0 being the
default priority. Events with higher priority are sent to the client before
events with lower priority.options.keepAlive: whether or not to automatically re-establish and
re-synchronize the link after connection failures. Defaults to false.Returns a ListDownlink that synchronizes its state with a remote ordered list lane.
options.prio: the desired priority of events on the link. A priority is
a floating point ranging value between -1.0 and 1.0, with -1.0 being
the lowest priority, 1.0 being the highest priority, and 0.0 being the
default priority. Events with higher priority are sent to the client before
events with lower priority.options.keepAlive: whether or not to automatically re-establish and
re-synchronize the link after connection failures. Defaults to false.Returns a MapDownlink that synchronizes its state with a remote map lane.
options.sortBy: function with which to sort downlinked map state, or a
dot-notation string that specifies the path of a value to sort by. Defaults
to undefined, which leaves the downlinked map state unsorted.options.prio: the desired priority of events on the link. A priority is
a floating point ranging value between -1.0 and 1.0, with -1.0 being
the lowest priority, 1.0 being the highest priority, and 0.0 being the
default priority. Events with higher priority are sent to the client before
events with lower priority.options.keepAlive: whether or not to automatically re-establish and
re-synchronize the link after connection failures. Defaults to false.Sends a command to a lane of a remote service. If provided, hostUri
specifies the network endpoint of the service to command, otherwise nodeUri
must itself contain a network authority component. nodeUri identifies the
particular service instance to command. body is the command to send, and
can be any JSON-compatible object; body is serialized as a
RECON structure.
Returns a new HostScope object bound to the endpoint at the
given hostUri.
Returns a new NodeScope object bound to the service at the given
nodeUri. If provided, hostUri specifies the network endpoint to connect
to, otherwise nodeUri must contain a network authority component.
Returns a new LaneScope object bound to the given laneUri of
the service at the given nodeUri. If provided, hostUri specifies the
network endpoint to connect to, otherwise nodeUri must contain a network
authority component.
Unlinks all downlinks, and closes all network connections, associated with
the client connection pool.
Client callbacks are invoked on the delegate member of a Client object.
By default, a Client is its own delegate, so callbacks can be assigned
directly to the client object. If delegate is reassigned, then callbacks
will instead by invoked on the assigned delegate object.
The onConnect callback gets invoked when a network connection managed by the
client is connected.
info.hostUri: the URI of the host that connected.The onConnect callback gets invoked when a network connection managed by the
client is disconnected.
info.hostUri: the URI of the host that disconnected.The onError callback gets invoked when a network connection managed by the
client encounters an error.
info.hostUri: the URI of the host that disconnected.The onAuthorize callback gets invoked when a network connection managed by
the client is successfully authorized by the remote host.
info.hostUri: the URI of the authorized host.info.session: the authorization parameters returned by the remote host.The onDeauthorize callback gets invoked when a network connection managed by
the client is deauthorized by the remote host, or when the host rejects an
authorization request.
info.hostUri: the URI of the deauthorized host.info.session: the authorization parameters returned by the remote host.A Scope object monitors the lifecycle of downlinks created
through the scope.
hostUri.nodeUri.laneUri
of some remote nodeUri.Returns true if there is an active network connection to this scope's remote host.
Returns true if the network connection to this scope's remote host has been
successfully authorized.
Returns the authorization parameters provided by the remote host, if the
client was explicitly authorized by the host. Returns null if the connection
is closed, or if the connection is open but not authorized.
Unlinks all downlinks registered with the scope.
Scope callbacks are invoked on the delegate member of a Scope object.
By default, a Scope is its own delegate, so callbacks can be assigned
directly to the scope object. If delegate is reassigned, then callbacks
will instead by invoked on the assigned delegate object.
The onConnect callback gets invoked when a network connection to the scope's
remote host is connected.
info.hostUri: the URI of the host that connected.The onConnect callback gets invoked when a network connection to the scope's
remote host is disconnected.
info.hostUri: the URI of the host that disconnected.The onError callback gets invoked when a network connection to the scope's
remote host encounters an error.
info.hostUri: the URI of the host that disconnected.The onAuthorize callback gets invoked when a network connection to the scope's
remote host is successfully authorized by the host.
info.hostUri: the URI of the authorized host.info.session: the authorization parameters returned by the remote host.The onDeauthorize callback gets invoked when a network connection to the
scope's remote host is deauthorized by the host, or when the host rejects an
authorization request.
info.hostUri: the URI of the deauthorized host.info.session: the authorization parameters returned by the remote host.HostScope extends the Scope interface.
Returns the URI of the network endpoint to which the scope is bound.
Authorizes connections to the host to which this scope is bound using the
provided credentials object.
Returns a new DownlinkBuilder for constructing a link to a lane of a node on the remote host to which this scope is bound.
Returns a Downlink to a lane of a node on the remote host to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a synchronized Downlink to a lane of a node on the remote host to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a ListDownlink that synchronizes its state with an ordered list lane of a node on the remote host to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a MapDownlink that synchronizes its state with a map lane of a node on the remote host to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Sends a command to a lane of a node on the remote host to which this scope is bound.
Returns a new NodeScope object bound to the given nodeUri on the remote
hostUri to which this scope is bound.
Returns a new LaneScope object bound to the given laneUri of
the given nodeUri on the remote hostUri to which this scope is bound.
Unlinks all downlinks registered with the scope.
NodeScope extends the Scope interface.
Returns the URI of the remote host to which the scope is bound.
Returns the URI of the remote node to which the scope is bound. Returns an
absolute URI resolved against the hostUri.
Returns a new DownlinkBuilder for constructing a link to a lane of the remote node to which this scope is bound.
Returns a Downlink to a lane of the remote node to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a synchronized Downlink to a lane of the remote node to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a ListDownlink that synchronizes its state with an ordered list lane of the remote node to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a MapDownlink that synchronizes its state with a map lane of the remote node to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Sends a command to a lane of the remote node to which this scope is bound.
Returns a new LaneScope object bound to the given laneUri of
the nodeUri and the hostUri to which this scope is bound.
Unlinks all downlinks registered with the scope.
LaneScope extends the Scope interface.
Returns the URI of the remote host to which the scope is bound.
Returns the URI of the remote node to which the scope is bound. Returns an
absolute URI resolved against the hostUri.
Returns the URI of the lane to which the scope is bound.
Returns a new DownlinkBuilder for constructing a link to the remote lane to which this scope is bound.
Returns a Downlink to the remote lane to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a synchronized Downlink to the remote lane to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a ListDownlink that synchronizes its state with the remote ordered list lane to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Returns a MapDownlink that synchronizes its state with the remote map lane to which this scope is bound. Registers the returned downlink with the scope to ensure that the link is cleaned up when the scope closes.
Sends a command to the remote lane to which this scope is bound.
Unlinks all downlinks registered with the scope.
Returns the URI of the host to which downlink connects.
Returns the URI of the remote node to which downlink connects. Returns an
absolute URI resolved against the hostUri.
Returns the URI of the lane to which downlink connects.
Returns the options object provided when downlink was created.
Returns the floating point priority level of the downlink.
Returns true if the link should be automatically re-established after
connection failures. The keepAlive mode can be changed at any time by
assigning a new value to this property.
Returns true if the link is currently connected.
Returns true if the network connection carrying the link has been explicitly
authorized. Note that not all links require authorization.
Returns the authorization parameters of the network connection carrying this
link, if the link was explicitly authorized by the remote host. Returns null
if the link is disconnected, or if the link is connected but not authorized.
Returns the object on which to invoke event callbacks. Defaults to the
downlink object itself. The event delegate can be changed by assigning a
new object to this property.
Sends a command to the remote lane to which this downlink is connected.
Unregisters the downlink so that it no longer receives events. If this was the only active link to a particular remote lane, the link will be unlinked.
Downlink callbacks are invoked on the delegate member of a Downlink object.
By default, a Downlink is its own delegate, so callbacks can be assigned
directly to the downlink object. If delegate is reassigned, then callbacks
will instead by invoked on the assigned delegate object.
The onEvent callback gets invoked every time the downlink receives an event.
message.nodeUri: the URI of the remote node that published the event.message.laneUri: the URI of the lane that published the event.message.body: the plain old JavaScript value of the event, decoded from RECON.The onLink callback gets invoked when the downlink is about to send a @link
request to the remote host to establish a new link.
request.nodeUri: the URI of the remote node to link.request.laneUri: the URI of the lane to link.request.prio: the requested priority of the link.request.body: an optional request body to send to the remote lane.The onLinked callback gets invoked when the downlink receives a @linked
response from the remote host, indicating the link has been established.
response.nodeUri: the URI of the linked remote node.response.laneUri: the URI of the linked lane.response.prio: the established priority of the link.response.body: an optional response body sent by the remote lane.The onSync callback gets invoked when the downlink is about to send a @sync
request to the remote host to establish a new link and synchronize its state.
request.nodeUri: the URI of the remote node to sync.request.laneUri: the URI of the lane to sync.request.prio: the requested priority of the link.request.body: an optional request body to send to the remote lane.The onSynced callback gets invoked when the downlink receives a @synced
response from the remote host, indicating that the link has finished sending
its initial state events.
response.nodeUri: the URI of the synced remote node.response.laneUri: the URI of the synced lane.response.body: an optional response body sent by the remote lane.The onUnlink callback gets invoked when the downlink is about to send an
@unlink request to the remote host in order to teardown a previously
established link. This happens when the client calls downlink.close() on
the only active link to a particular remote lane.
request.nodeUri: the URI of the remote node to unlink.request.laneUri: the URI of the lane to unlink.request.body: an optional request body to send to the remote lane.The onUnlinked callback gets invoked when the downlink receives an @unlinked
response from the remote host. This indicates that the remote host has
rejected the link. The link will now close, regardless of whether
downlink.keepAlive is true or not.
response.nodeUri: the URI of the unlinked remote node.response.laneUri: the URI of the unlinked lane.response.body: an optional response body sent by the remote lane, which may
indicate the cause of the unlink.The onConnect callback gets invoked when the network connection that carries
the link is connected.
The onDisconnect callback gets invoked when the network connection that
carries the link is disconnected.
The onError callback gets invoked when the network connection that carries
the link encounters an error. Unfortunately, the underlying network APIs
don't provide any detail on network errors. Errors always cause the underlying
network connection to close; keepAlive links will automatically reconnect
after network errors.
The onClose callback gets invoked when the downlink has been disconnected and
will not be reconnected. This happens when the client calls downlink.close(),
or when the link is explicityly @unlinked by the remote host, or when the
network connection that carries a non-keepAlive link gets disconnected.
A ListDownlink synchronizes its state with a remote ordered ListLane. A
ListDownlink supports the full functionality of an ordinary Downlink.
It also implements array-like methods. All list operations are transparently
synchronized with the remote lane. And all operations on the remote lane are
transparently synchronized with the ListDownlink object.
Note that the complete state of the list is not gauranteed to be available
until the onSynced callback has been invoked. And the downlinked list state
may desync when the link's underlying network connection drops.
Returns the number of values in the downlinked list state.
Returns the value at index in the downlinked list state.
Sets value at index of the downlinked list state, and pushes the change to
the remote lane.
Appends one or more values to the end of the downlinked list state, and pushes the changes to the remote lane. Returns the new length of the list.
Removes and returns the last value of the downlinked list state, pushing any
change to the remote lane. Returns undefined if the list is empty.
Prepends one or more values to the beginning of the downlinked list state, and pushes the changes to the remote lane. Returns the new length of the list.
Removes and returns the first value of the downlinked list state, pushing any
change to the remote lane. Returns undefined if the list is empty.
Moves that value at index fromIndex to index toIndex, pushing the change
to the remote lane.
Removes deleteCount elements from the downlinked list state, starting at
index start, and inserts zero or more new values at startIndex. Pushes
all changes to the remote lane.
Removes all values from the downlinked list state, as well as the remote list lane.
Returns this.
Invokes callback for every value in the downlinked list state. If provided,
thisArg will be passed to each invocation of callback for use as its this value.
callback is invoked with three arguments:
listDownlink being traversedReturns the internal downlinked list state as an array.
A MapDownlink synchronizes its state with a remote MapLane. A MapDownlink
supports the full functionality of an ordinary Downlink. It also
implements the behavior of a JavaScript key-value Map. All map operations
are transparently synchronized with the remote lane. And all operations on
the remote lane are transparently syncrhonized with the MapDownlink object.
MapDownlink seamlessly supports complex key objects.
Note that the complete state of the map is not guaranteed to be available until
the onSynced callback has been invoked. And the downlinked map state may
desync when the link's underlying network connection drops.
Returns the number of entries in the downlinked map state.
Returns true if the downlinked map state contains a given key.
Returns the value associated with a given key in the downlinked map state.
Associates a value with a given key in the downlinked map state. Pushes
the change to the remote lane. Returns this.
Removes an entry with key from the downlinked map state, pushing any change
to the remote map lane. Returns true if an entry was removed, otherwise
returns false.
Removes all entries from the downlinked map state, as well as the remote map lane.
Returns this.
Returns an array of all keys in the downlinked map state.
Returns an array of all values in the downlinked map state.
Invokes callback for every value in the downlinked map state. If provided,
thisArg will be passed to each invocation of callback for use as its this value.
callback is invoked with three arguments:
mapDownlink being traversedReturns the function used to sort the downlinked map state.
Returns the internal downlinked map state as an array.
Sets the host URI of the downlink to create and returns this.
Sets the node URI of the downlink to create and returns this.
Sets the lane URI of the downlink to create and returns this.
Sets the priority of the downlink to create and returns this.
Sets the boolean keep-alive mode of the downlink to create and returns this.
Sets the event delegate object of the downlink to create and returns this.
Sets the onEvent callback of the downlink to create and returns this.
Sets the onCommand callback of the downlink to create and returns this.
Sets the onLink callback of the downlink to create and returns this.
Sets the onLinked callback of the downlink to create and returns this.
Sets the onSync callback of the downlink to create and returns this.
Sets the onSynced callback of the downlink to create and returns this.
Sets the onUnlink callback of the downlink to create and returns this.
Sets the onUnlinked callback of the downlink to create and returns this.
Sets the onConnect callback of the downlink to create and returns this.
Sets the onDisconnect callback of the downlink to create and returns this.
Sets the onError callback of the downlink to create and returns this.
Sets the onClose callback of the downlink to create and returns this.
Sets the sortBy function option of the synchronized map downlink to create
and returns this.
Returns a Downlink parameterized by the builder's configuration.
Returns a synchronized Downlink parameterized by the builder's configuration.
Returns a synchronized ListDownlink parameterized by the builder's configuration.
Returns a synchronized MapDownlink parameterized by the builder's configuration.
FAQs
Swim JavaScript Client
The npm package swim-client-js receives a total of 0 weekly downloads. As such, swim-client-js popularity was classified as not popular.
We found that swim-client-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."