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

@mainframe/rpc-handler

v0.3.0

Published

JSON-RPC handler

Downloads

8

Readme

rpc-handler

JSON-RPC messages handler.

Installation

yarn add @mainframe/rpc-handler

Usage

import createHandler from '@mainframe/rpc-handler'

const handle = createHandler({
  methods: {
    hello: {
      params: {
        name: 'string'
      },
      handler(ctx, params) => `hello ${params.name}`,
    },
    ping: () => 'pong',
  },
})

const context = {}

const incomingMessage = {
  jsonrpc: '2.0',
  id: 'test',
  method: 'hello',
  params: {
    name: 'bob',
  },
}

const outgoingMessage = await handle(context, incomingMessage)
// outgoingMessage = {jsonrpc: '2.0', id: 'test', result: 'hello bob'}

Types

RPCRequest

Imported from @mainframe/rpc-base

RPCResponse

Imported from @mainframe/rpc-base

ErrorHandler

type ErrorHandler = <C = any, P = any>(ctx: C, msg: RPCRequest<P>, error: Error) => void

MethodHandler

type MethodHandler = <C = any, P = any, R = any>(ctx: C, params: P) => R | Promise<R>

NotificationHandler

type NotificationHandler = <C = any, P = any>(ctx: C, msg: RPCRequest<P>) => void

MethodWithParams

interface MethodWithParams {
  params?: Record<string, any> | undefined
  handler: MethodHandler
}

Methods

type Methods = Record<string, MethodHandler | MethodWithParams>

HandlerParams

type HandlerParams = {
  methods: Methods,
  onHandlerError?: ErrorHandler | undefined,
  onInvalidMessage?: NotificationHandler | undefined,
  onNotification?: NotificationHandler | undefined,
  validatorOptions?: any | undefined,
}

HandlerFunc

type HandlerFunc = <C = any, P = any, R = any, E = any>(
  ctx: C,
  req: RPCRequest<P>,
) => Promise<RPCResponse<R, E>>

API

createHandler()

Default export of the library

Arguments

  1. params: HandlerParams

Returns HandlerFunc

parseJSON()

Tries to parse a JSON string, or throws a RPCError with code -32700 (parse error)

Arguments

  1. input: string

Returns T = any

License

MIT