The @swim/system umbrella framework provides a standalone set of frameworks for building massively real-time streaming WARP client applications. @swim/system incorporates the @swim/core foundation framework, and the @swim/mesh multiplexed streaming WARP client framework.
The Swim System umbrella framework has no external dependencies when run in a web browser, and depends only on a WebSocket implementation when run in Node.js. Swim System provides the following top-level libraries:
The Swim Core framework provides a lightweight, portable, dependency-free, and strongly typed baseline on which to build higher level libraries. Swim Core consists of the following component libraries:
strftime-style parsers and formatters.
The Swim Mesh framework implements a multiplexed streaming WARP client that runs in both Node.js and web browsers. Swim Mesh consists of the following component libraries:
For an npm-managed project,
npm install @swim/system to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/system/lib/main. And a pre-built UMD script, which
bundles all @swim/system child frameworks, can be found in
Browser applications can load
swim-system.js directly from the SwimOS CDN.
swim-system.js bundle is self-contained; it supersedes
swim-mesh.js—those scripts need not be loaded when using
<!-- Development --> <script src="https://cdn.swimos.org/js/latest/swim-system.js"></script> <!-- Production --> <script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
@swim/system can be imported as an ES6 module from TypeScript and other
ES6-compatible environments. All child framework libraries are re-exported
by the umbrella
import * as swim from "@swim/system";
@swim/system can also be used as a CommonJS module in Node.js applications.
All child framework libraries are re-exported by the umbrella
var swim = require("@swim/system");
When loaded by a web browser, the
swim-system.js script adds all child
framework exports to the global
Generated using TypeDoc