npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

svelte-websocket-stores

v1.1.6

Published

Synchronize primitive-typed Svelte stores across a simple WebSocket connection.

Downloads

227

Readme

svelte-websocket-stores

Synchronize primitive-typed Svelte stores across a simple WebSocket connection.

npm version license

Purpose

This was originally designed to allow touch panels to use Svelte with any backend.

Usage

Initialization

import { WebSocketWrapper } from "svelte-websocket-stores/websocket"

export const sws: WebSocketWrapper = new WebSocketWrapper({
	server_address: "192.168.0.64",
	server_port: 80,
	local_scope: "tp1"
});
sws.start();

Write-only example

<script>
	import { sws } from "main.ts";

	let pressStore = sws.booleans.get("myCoolButton.press");

	function press() {
		$pressStore = true;
	}

	function release() {
		$pressStore = false;
	}
</script>

<button
	on:pointerdown={press}
	on:pointerup={release}
	on:pointerout={release}>
	<slot />
</button>

Read-only exmaple

<script>
	import { sws } from "main.ts";

	let sizeStore = sws.numbers.get("myList.size");
</script>

<div>
	{#each { length: $sizeStore } as _, index}
		<slot />
	{/each}
</div>

WebSocket Message Format

All communication between a server and this library is over WebSocket.

All WebSocket messages are interpreted as JSON objects.

The message object is defined as:

type Message = {
	scope: string,
	id: string,
	type: "boolean" | "number" | "string" | "object",
	value: boolean | number | string | object,
}

The field scope identifies the scope of the client it comes from and limits which clients receive it when coming from the server. The field type determines how the value field is interpreted as well as which of the tables (booleans, numbers, strings, or objects) the id field will be indexing into.

Client

Message Received

  1. The incoming text data is parsed as JSON.
  2. The object's scope field is checked if it is global ("global") or matches the client's local scope (for example "tp1"). If it does not match, the message is discarded.
  3. The object's type field is switched on with the cases "boolean", "number", "string", and "object". If there is no match, the message is discarded.
  4. The local Svelte store is indexed by the object's id field from the dictionary holding the respectively typed stores.
  5. The store's value is assigned to the object's value field, cast to its respective type.

Server [^1]

Client Connected

  1. Send the client messages for all the variables currently stored values

Message Received

  1. The incoming text data is parsed as JSON.
  2. The object's type field is switched on with the cases "boolean", "number", "string", and "object". If there is no match, the message is discarded.
  3. The variable is indexed by the object's scope and id fields from the dictionary holding the respectively typed variables.
  4. The variable's value is assigned to the object's value field, cast to its respective type.
  5. Send all clients a message for the new value.
  6. Handle any events.

[^1]: This is the behavior expected by this WebSocket client