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

@archetypical/conduit

v1.0.97

Published

JavaScript client for Conduit

Downloads

99

Readme

Conduit Client

Conduit client is a javascript client designed to easily integrate with a Conduit server implementation. The Conduit client is intended to be used with a server Conduit implemented in .net core. Please see the full documentation here.

Installation

Install globally via npm:

npm install -g @archetypical/conduit

Or globally via yarn:

yarn global add @archetypical/conduit

Methods

Once you have established your server side Conduit you can connect to it with a new Conduit client. If you have used the signalr client before, you will recognize a lot of the same methods.

Instantiation

You are able to instantiate a conduit client with the default options:

const conduit = new Conduit();

Or you can provide configuration settings used to change the underlying reconnect behavior.

const conduit = new Conduit({
    logLevel: LogLevel.Error,
    retryInterval: 3000,
    maxConnectionAttempts: 5
});

For more information on these options, please refer to AutoHubConnection.

ApplyFilter

applyFilter(filterName: string, filter: object): Promise<void>

Call applyFilter to provide the server conduit additional data points to more accurately send data to the client.

filterName is expected to be the name of the class used in the server conduit to define filterable data for your users.

filter is the actual filter data to be used by the server conduit to filter calls.

Start

start(): Promise<void>

start initiates a connection with the server Conduit.

On

on<T>(payloadName: string, callback: (data: T) => void): Promise<void>

on adds a callback handler for when a specific payload type is provided.

payloadName is type name of the object pushed by the server Conduit.

callback is the method called whenever a payload of that type is pushed.

Off

off<T>(payloadName: string, callback?: (data: T) => void): void

off removes a handler or all handlers for a specific payload type.

payloadName is the type name of the object pushed by the server Conduit.

callback is the method you want removed whenever a payload of that type is pushed.

Example

import { Conduit } from '@archetypical/conduit'

// Create a new client
const conduit = new Conduit();

// Initiate the connection
await conduit.start();

// Define a callback handler for PageStats
await conduit.on('PageStats', updatePageStats);

// Tell the server you only want updates for specific pages
await conduit.applyFilter('UserFilterData', {
    RecentPages: ['Home', 'About', 'Kittens']
});