v0.0.4

Author: jamesgpearce

coverage.json

@@ -1 +1 @@
-{"tests":711,"assertions":26626,"lines":{"total":401,"covered":381,"skipped":0,"pct":95.01},"statements":{"total":444,"covered":421,"skipped":0,"pct":94.81},"functions":{"total":146,"covered":134,"skipped":0,"pct":91.78},"branches":{"total":245,"covered":177,"skipped":0,"pct":72.24},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
+{"tests":792,"assertions":29845,"lines":{"total":401,"covered":381,"skipped":0,"pct":95.01},"statements":{"total":444,"covered":421,"skipped":0,"pct":94.81},"functions":{"total":146,"covered":134,"skipped":0,"pct":91.78},"branches":{"total":245,"covered":177,"skipped":0,"pct":72.24},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}

docs/api/all.html

@@ -1 +1 @@
-<nav><ul><li><a href="/">Synclets</a></li><li><a href="/api/">API</a></li></ul></nav><section class="s1" id="/api/" data-id="api"><h1>API</h1><section class="s2" id="/api/the-essentials/" data-id="e"><h2>The Essentials</h2><ul><li><a href="/api/the-essentials/configuring-a-synclet/createsynclet/"><code>createSynclet</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createdataconnector/"><code>createDataConnector</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createmetaconnector/"><code>createMetaConnector</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createtransport/"><code>createTransport</code></a></li></ul></section><section class="s2" id="/api/synclets/" data-id="s"><h2><code>synclets</code></h2><p>The <code>synclets</code> module documents the core <a href="/api/synclets/interfaces/core/synclet/"><code>Synclet</code></a> types, helpers, and factory functions. <a href="/api/synclets/">Read more</a>.</p><ul><li><a href="/api/synclets/interfaces/">Interfaces</a></li><li><a href="/api/synclets/functions/">Functions</a></li><li><a href="/api/synclets/type-aliases/">Type Aliases</a></li><li><a href="/api/synclets/variables/">Variables</a></li></ul></section><section class="s2" id="/api/utils/" data-id="u"><h2><code>utils</code></h2><p>The <code>utils</code> module gathers shared helper types for JSON parsing, hashing, and packet encoding. <a href="/api/utils/">Read more</a>.</p><ul><li><a href="/api/utils/functions/utility/gethash/"><code>getHash</code></a></li><li><a href="/api/utils/functions/utility/getpacketfromparts/"><code>getPacketFromParts</code></a></li><li><a href="/api/utils/functions/utility/getpartsfrompacket/"><code>getPartsFromPacket</code></a></li><li><a href="/api/utils/functions/utility/getuniqueid/"><code>getUniqueId</code></a></li><li><a href="/api/utils/functions/utility/isatom/"><code>isAtom</code></a></li><li><a href="/api/utils/functions/utility/istimestamp/"><code>isTimestamp</code></a></li><li><a href="/api/utils/functions/utility/jsonparse/"><code>jsonParse</code></a></li><li><a href="/api/utils/functions/utility/jsonstring/"><code>jsonString</code></a></li></ul></section><section class="s2" id="/api/connector-browser/" data-id="c"><h2><code>connector/browser</code></h2><p>The <code>connector/browser</code> module covers LocalStorage and SessionStorage connector types. <a href="/api/connector-browser/">Read more</a>.</p><ul><li><a href="/api/connector-browser/interfaces/">Interfaces</a></li><li><a href="/api/connector-browser/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-database/" data-id="c2"><h2><code>connector/database</code></h2><p>The <code>connector/database</code> module defines shared option types for SQL-style connectors. <a href="/api/connector-database/">Read more</a>.</p><ul><li><a href="/api/connector-database/type-aliases/option/databasedataoptions/"><code>DatabaseDataOptions</code></a></li><li><a href="/api/connector-database/type-aliases/option/databasemetaoptions/"><code>DatabaseMetaOptions</code></a></li></ul></section><section class="s2" id="/api/connector-database-pglite/" data-id="c3"><h2><code>connector/database/pglite</code></h2><p>The <code>connector/database/pglite</code> module documents connectors backed by the embedded PGlite database. <a href="/api/connector-database-pglite/">Read more</a>.</p><ul><li><a href="/api/connector-database-pglite/interfaces/">Interfaces</a></li><li><a href="/api/connector-database-pglite/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-database-sqlite3/" data-id="c4"><h2><code>connector/database/sqlite3</code></h2><p>The <code>connector/database/sqlite3</code> module describes connectors that persist data in sqlite3. <a href="/api/connector-database-sqlite3/">Read more</a>.</p><ul><li><a href="/api/connector-database-sqlite3/interfaces/">Interfaces</a></li><li><a href="/api/connector-database-sqlite3/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-fs/" data-id="c5"><h2><code>connector/fs</code></h2><p>The <code>connector/fs</code> module documents file- and directory-backed connector types for Node environments. <a href="/api/connector-fs/">Read more</a>.</p><ul><li><a href="/api/connector-fs/interfaces/">Interfaces</a></li><li><a href="/api/connector-fs/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-memory/" data-id="c6"><h2><code>connector/memory</code></h2><p>The <code>connector/memory</code> module provides volatile connectors for tests, demos, and ephemeral synclets. <a href="/api/connector-memory/">Read more</a>.</p><ul><li><a href="/api/connector-memory/functions/connector/creatememorydataconnector/"><code>createMemoryDataConnector</code></a></li><li><a href="/api/connector-memory/functions/connector/creatememorymetaconnector/"><code>createMemoryMetaConnector</code></a></li></ul></section><section class="s2" id="/api/connector-tinybase/" data-id="c7"><h2><code>connector/tinybase</code></h2><p>The <code>connector/tinybase</code> module describes the adapters that wrap TinyBase stores as connectors. <a href="/api/connector-tinybase/">Read more</a>.</p><ul><li><a href="/api/connector-tinybase/interfaces/connector/tinybasedataconnector/"><code>TinyBaseDataConnector</code></a> interface</li><li><a href="/api/connector-tinybase/functions/connector/createtinybasedataconnector/"><code>createTinyBaseDataConnector</code></a> function</li></ul></section><section class="s2" id="/api/transport-memory/" data-id="t"><h2><code>transport/memory</code></h2><p>The <code>transport/memory</code> module covers the in-process transport used for local testing. <a href="/api/transport-memory/">Read more</a>.</p><ul><li><a href="/api/transport-memory/functions/transport/creatememorytransport/"><code>createMemoryTransport</code></a></li></ul></section><section class="s2" id="/api/transport-ws/" data-id="t2"><h2><code>transport/ws</code></h2><p>The <code>transport/ws</code> module documents WebSocket-based transports for browser and Node runtimes. <a href="/api/transport-ws/">Read more</a>.</p><ul><li><a href="/api/transport-ws/interfaces/transport/wstransport/"><code>WsTransport</code></a> interface</li><li><a href="/api/transport-ws/functions/transport/createwstransport/"><code>createWsTransport</code></a> function</li><li><a href="/api/transport-ws/type-aliases/transport/websockettypes/"><code>WebSocketTypes</code></a> type alias</li></ul></section><section class="s2" id="/api/server-stateless-ws/" data-id="s5"><h2><code>server/stateless-ws</code></h2><p>The <code>server/stateless-ws</code> module defines the minimal stateless WebSocket server wrapper types. <a href="/api/server-stateless-ws/">Read more</a>.</p><ul><li><a href="/api/server-stateless-ws/interfaces/server/statelesswsserver/"><code>StatelessWsServer</code></a> interface</li><li><a href="/api/server-stateless-ws/functions/server/createstatelesswsserver/"><code>createStatelessWsServer</code></a> function</li></ul></section></section>
+<nav><ul><li><a href="/">Synclets</a></li><li><a href="/api/">API</a></li></ul></nav><section class="s1" id="/api/" data-id="api"><h1>API</h1><section class="s2" id="/api/the-essentials/" data-id="e"><h2>The Essentials</h2><ul><li><a href="/api/the-essentials/configuring-a-synclet/createsynclet/"><code>createSynclet</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createdataconnector/"><code>createDataConnector</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createmetaconnector/"><code>createMetaConnector</code></a></li><li><a href="/api/the-essentials/configuring-a-synclet/createtransport/"><code>createTransport</code></a></li></ul></section><section class="s2" id="/api/synclets/" data-id="s"><h2><code>synclets</code></h2><p>The <code>synclets</code> module documents the core <a href="/api/synclets/interfaces/core/synclet/"><code>Synclet</code></a> types, helpers, and factory functions. <a href="/api/synclets/">Read more</a>.</p><ul><li><a href="/api/synclets/interfaces/">Interfaces</a></li><li><a href="/api/synclets/functions/">Functions</a></li><li><a href="/api/synclets/type-aliases/">Type Aliases</a></li><li><a href="/api/synclets/variables/">Variables</a></li></ul></section><section class="s2" id="/api/utils/" data-id="u"><h2><code>utils</code></h2><p>The <code>utils</code> module gathers shared helper types for JSON parsing, hashing, and packet encoding. <a href="/api/utils/">Read more</a>.</p><ul><li><a href="/api/utils/functions/utility/gethash/"><code>getHash</code></a></li><li><a href="/api/utils/functions/utility/getpacketfromparts/"><code>getPacketFromParts</code></a></li><li><a href="/api/utils/functions/utility/getpartsfrompacket/"><code>getPartsFromPacket</code></a></li><li><a href="/api/utils/functions/utility/getuniqueid/"><code>getUniqueId</code></a></li><li><a href="/api/utils/functions/utility/isatom/"><code>isAtom</code></a></li><li><a href="/api/utils/functions/utility/istimestamp/"><code>isTimestamp</code></a></li><li><a href="/api/utils/functions/utility/jsonparse/"><code>jsonParse</code></a></li><li><a href="/api/utils/functions/utility/jsonstring/"><code>jsonString</code></a></li></ul></section><section class="s2" id="/api/connector-browser/" data-id="c"><h2><code>connector/browser</code></h2><p>The <code>connector/browser</code> module covers LocalStorage and SessionStorage connector types. <a href="/api/connector-browser/">Read more</a>.</p><ul><li><a href="/api/connector-browser/interfaces/">Interfaces</a></li><li><a href="/api/connector-browser/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-database/" data-id="c2"><h2><code>connector/database</code></h2><p>The <code>connector/database</code> module defines shared option types for SQL-style connectors. <a href="/api/connector-database/">Read more</a>.</p><ul><li><a href="/api/connector-database/type-aliases/option/databasedataoptions/"><code>DatabaseDataOptions</code></a></li><li><a href="/api/connector-database/type-aliases/option/databasemetaoptions/"><code>DatabaseMetaOptions</code></a></li></ul></section><section class="s2" id="/api/connector-database-pglite/" data-id="c3"><h2><code>connector/database/pglite</code></h2><p>The <code>connector/database/pglite</code> module documents connectors backed by the embedded PGlite database. <a href="/api/connector-database-pglite/">Read more</a>.</p><ul><li><a href="/api/connector-database-pglite/interfaces/">Interfaces</a></li><li><a href="/api/connector-database-pglite/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-database-sqlite3/" data-id="c4"><h2><code>connector/database/sqlite3</code></h2><p>The <code>connector/database/sqlite3</code> module describes connectors that persist data in sqlite3. <a href="/api/connector-database-sqlite3/">Read more</a>.</p><ul><li><a href="/api/connector-database-sqlite3/interfaces/">Interfaces</a></li><li><a href="/api/connector-database-sqlite3/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-fs/" data-id="c5"><h2><code>connector/fs</code></h2><p>The <code>connector/fs</code> module documents file- and directory-backed connector types for Node environments. <a href="/api/connector-fs/">Read more</a>.</p><ul><li><a href="/api/connector-fs/interfaces/">Interfaces</a></li><li><a href="/api/connector-fs/functions/">Functions</a></li></ul></section><section class="s2" id="/api/connector-memory/" data-id="c6"><h2><code>connector/memory</code></h2><p>The <code>connector/memory</code> module provides volatile connectors for tests, demos, and ephemeral synclets. <a href="/api/connector-memory/">Read more</a>.</p><ul><li><a href="/api/connector-memory/functions/connector/creatememorydataconnector/"><code>createMemoryDataConnector</code></a></li><li><a href="/api/connector-memory/functions/connector/creatememorymetaconnector/"><code>createMemoryMetaConnector</code></a></li></ul></section><section class="s2" id="/api/connector-tinybase/" data-id="c7"><h2><code>connector/tinybase</code></h2><p>The <code>connector/tinybase</code> module describes the adapters that wrap TinyBase stores as connectors. <a href="/api/connector-tinybase/">Read more</a>.</p><ul><li><a href="/api/connector-tinybase/interfaces/connector/tinybasedataconnector/"><code>TinyBaseDataConnector</code></a> interface</li><li><a href="/api/connector-tinybase/functions/connector/createtinybasedataconnector/"><code>createTinyBaseDataConnector</code></a> function</li></ul></section><section class="s2" id="/api/transport-broadcast-channel/" data-id="t"><h2><code>transport/broadcast-channel</code></h2><p>The <code>transport/broadcast-channel</code> module documents BroadcastChannel-based transports for browsers. <a href="/api/transport-broadcast-channel/">Read more</a>.</p><ul><li><a href="/api/transport-broadcast-channel/interfaces/transport/broadcastchanneltransport/"><code>BroadcastChannelTransport</code></a> interface</li><li><a href="/api/transport-broadcast-channel/functions/transport/createbroadcastchanneltransport/"><code>createBroadcastChannelTransport</code></a> function</li></ul></section><section class="s2" id="/api/transport-memory/" data-id="t2"><h2><code>transport/memory</code></h2><p>The <code>transport/memory</code> module covers the in-process transport used for local testing. <a href="/api/transport-memory/">Read more</a>.</p><ul><li><a href="/api/transport-memory/functions/transport/creatememorytransport/"><code>createMemoryTransport</code></a></li></ul></section><section class="s2" id="/api/transport-ws/" data-id="t3"><h2><code>transport/ws</code></h2><p>The <code>transport/ws</code> module documents WebSocket-based transports for browser and Node runtimes. <a href="/api/transport-ws/">Read more</a>.</p><ul><li><a href="/api/transport-ws/interfaces/transport/wstransport/"><code>WsTransport</code></a> interface</li><li><a href="/api/transport-ws/functions/transport/createwstransport/"><code>createWsTransport</code></a> function</li><li><a href="/api/transport-ws/type-aliases/transport/websockettypes/"><code>WebSocketTypes</code></a> type alias</li></ul></section><section class="s2" id="/api/server-stateless-ws/" data-id="s5"><h2><code>server/stateless-ws</code></h2><p>The <code>server/stateless-ws</code> module defines the minimal stateless WebSocket server wrapper types. <a href="/api/server-stateless-ws/">Read more</a>.</p><ul><li><a href="/api/server-stateless-ws/interfaces/server/statelesswsserver/"><code>StatelessWsServer</code></a> interface</li><li><a href="/api/server-stateless-ws/functions/server/createstatelesswsserver/"><code>createStatelessWsServer</code></a> function</li></ul></section></section>