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

@jup-ag/notification-sdk

v0.2.4

Published

### Install ``` npm i @jup-ag/notification-sdk ```

Downloads

9

Readme

Notification SDK

Install

npm i @jup-ag/notification-sdk

Subscribing to message updates

import { CreateNotificationClient, Status } from "@jup-ag/notification-sdk";

const workerEndpoint = "http://127.0.0.1:8787"

function handler(key: string, status: Status, code: string, description: string) {
  console.log(`Got new message for ${key}; Status: ${status}; Code: ${code}; Description: ${description}`)
}

function main() {
  const notificationClient = CreateNotificationClient(workerEndpoint)
  const key = "SomePositionRequestPubKeyBase58"
  notificationClient.onUpdate(key, handler)
}

Set new message

import { CreateNotificationClient, Status, Message } from "@jup-ag/notification-sdk";

const workerEndpoint = "http://127.0.0.1:8787"

async function main() {
  const notificationClient = CreateNotificationClient(workerEndpoint)
  const key = "SomePositionRequestPubKeyBase58"

  const message: Message = {
    status: Status.Error,
    code: "6001",
    description: "Something went wrong"
  }

  const ok = await notificationClient.updateMessage(key, message)

  if (!ok) {
    throw new Error("Failed to update status")
  }

  const res = await notificationClient.getMessage(key)
  console.log({ res })
}

About Message

Message is a JSON serializable object containing 3 properties

  • status: status is an enum with 4 possibilities -> Pending, Error, Success, Failed
  • code: this can be an error code as a string ie '6001' or 'MAX_ATTEMPTS'
  • description: this can be a user friendlier description of the error code

About Status

While you can use it very flexibly, this is how we intend to use it:

  • Status.Pending -> indicate that it is still in process
  • Status.Error -> error messages but might not indicate finality aka retries might be on the way
  • Status.Failed -> this indicate finality. no more retries
  • Status.Success -> everything is good