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

typed-wamp

v0.2.2

Published

A set of type definitions and convenience classes for working with WAMP messages.

Downloads

17

Readme

typed-wamp

Build Statuscodecovnpm version

This is a package that provides accurate TypeScript type definitions and basic message wrappers for the WAMP protocol.

This package doesn't do much by itself. It lets other code, like client and router implementations, use a uniform set of typed and wrappers for working with the WAMP protocol.

Wrappers and Enums

These work in both JS and TS.

Message Type Codes

Via the WampType enum:

import { WampType } from "typed-wamp";

let x = WampType.HELLO;
let y = WampType.GOODBYE;

WAMP Message Wrapper Objects

These are object versions of WAMP messages, that support properties and methods. They are easier to work with than naked arrays.

Craft using a constructor:

import { Wamp } from "typed-wamp";

let msgGoodbye = new Wamp.Goodbye({}, "goodbye reason");
let msgHello = new Wamp.Hello("realm", { /* ... */ });

Parse from an array object:

let raw = [1, "realm", helloDetails];
let parsed = Wamp.parse(raw);

Turn back to raw form:

let raw2 = parsed.toRaw();
console.log(raw2); // [1, "realm", helloDetails]

Common URIs

URIs mentioned in the WAMP specification.

import { WampUri } from "typed-wamp";

let reason = WampUri.Error.NotAuthorized; // wamp.error.not_authorized
let onRegisterTopicName = WampUri.Registration.OnRegister; // wamp.registration.on_register

Type Definitions

These only make sense from TypeScript.

WAMP Message Structure Definitions

These are in the namespace WampRaw.

import { WampRaw, WampType } from "typed-wamp";
import { WampType } from "typed-wamp";

let x: WampRaw.Hello = [WampType.HELLO, "realm", {...}];

WAMP Options Type Definitions

Type definitions for things like the HELLO message details field.

import {HelloDetails} from "typed-wamp";

let helloDetails: HelloDetails = {
    agent: "wampus",
    roles: {
        publisher: {
            features: {
                subscriber_blackwhite_listing: true
            }
        }
    },
    // ...
};

Limitations

This package intentionally doesn't address any specific authentication method, so it doesn't include specific wrappers for wampcra authentication (except for wrappers and types describing general Challenge and Authenticate messages).