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

@gameroom-js/client

v0.1.5

Published

## Overview

Downloads

2

Readme

@gameroom-js/client

Overview

A simple library for browser-based applications that allows you to rapidly develop stateful, socketed multiplayer games and web applications. For use in conjunction with the server library @gameroom-js/server.

Quickstart

index.ts

import {SocketConnection} from "@gameroom-js/client"

// create a new connection that will be used to communicate with the server via websockets
const connection = new SocketConnection({gameRoomID: "Lobby"});

// register listeners for roomState and gameState updates
connection.on("updateRoomState", (data) => {
  updateUIWithRoomState(data);
}
connection.on("updateGameState", (data) => {
  updateUIWithGameState(data);
}

// send Protocol, Action, and Transfer events
const clientStateButtonHandler = () => {
  connection.sendProtocol('REQUEST_CLIENT_STATE');
}
const nextTurnButtonHandler = () => {
  connection.sendAction('nextTurnPressed');
}
const formSubmitHandler = () => {
  connection.sendTransfer('updateClientName', {name: 'newName'});
}

SocketConnection

The main class of the gameroom-js client library is called SocketConnection. It is instantiated with the SocketConnectionOptions object, the interface for which is defined as follows:

export interface SocketConnectionOptions {
  url: string; // default: window.location.host
  gameRoomID: string; // default: 'Lobby'
  initiateCallback: () => (boolean | Promise<boolean>); // default: () => true
}

SocketConnectionOptions

The url string points to the web address where the server socket is listening. gameroom-js uses Socket.IO for websocket communication, if you would like to read more.

The gameRoomID string is the name of the game room that the client will try to connect to.

The initiateCallback function is an optional piece of logic used to verify from the client's end that the server can consider it fully connected. This callback will be called after the server sends the INITIATE_JOIN Protocol event. initiateCallback should return either true or false, indicating whether the server should continue connecting the client to the desired game room or reject it.

SocketConnection methods

  • connect(options: SocketConnectionOptions) Disconnects previous socket and instantiates a new one with options. Re-registers all listeners stored via the on method.
  • on() Registers the listener function as an event listener for event. Also stores the listener function for re-registration during a reconnection event.
  • disconnect() Disconnects socket by calling the disconnect method on the socket.
  • reconnect() Reconnects socket by calling the connect method on the socket.
  • sendProtocol(protocolType) Sends a Protocol event.
  • sendAction(actionType) Sends an Action event.
  • sendTransfer(transferType, payload) Sends a Transfer event.