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

r19

v0.1.8

Published

Simple remote procedure calls in TypeScript

Downloads

114,967

Readme

r19

npm version npm downloads Github Actions CI Codecov Conventional Commits License

Simple remote procedure calls (RPC) in TypeScript.

  • 🪡  Fully typed procedure calls using your TypeScript types — no runtime or code generation needed.
  • 🖼️  Handles binary data in both directions (think: file uploads and downloads).
  • 🎛️  Compatible with any Express-like server.

Install

npm install r19

Quick start

  1. Create an RPC Express middleware containing your procedures. A procedure is any sync or async function that accepts one or no arguments.

    // src/rpc-middleware.ts
    
    import { createRPCMiddleware, ExtractProcedures } from "r19";
    
    export const middleware = createRPCMiddleware({
    	procedures: {
    		ping: async () => {
    			await new Promise((resolve) => setTimeout(resolve, 1000));
    
    			return "pong";
    		},
    	},
    	// An optional error event handler
    	onError: ({ error, procedurePath, procedureArgs }) => { ... },
    });
    
    // This type will be passed to the RPC client.
    export type Procedures = ExtractProcedures<typeof middleware>;
  2. Add the middleware to your Express-compatible server.

    // src/server.ts
    
    import express from "express";
    import { middleware } from "./rpc-middleware";
    
    const app = express();
    
    // Pass `middleware` from the previous step.
    app.use("/rpc", middleware);
    
    app.listen();

    The server is now set up to accept RPC calls at /rpc using a client.

  3. In your remote app (e.g. your app's frontend), create a client to call the RPC server.

    // src/index.ts
    
    import { createRPCClient } from "r19/client";
    import type { Procedures } from "./rpc-middleware";
    
    const client = createRPCClient<Procedures>({
    	serverURL: "https://example.com/rpc",
    });
    
    const pong = await client.ping(); // => "pong"

    Calling client.ping() will send a request to the server at https://example.com/rpc and return ping()'s return value from the server. The client is fully typed using your procedure's types.

Documentation

For full documentation, visit the docs directory.

To discover what's new on this package check out the changelog.

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!

Asking a question: Open a new topic on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.

Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more clarity on this project and its structure you can also check out the detailed CONTRIBUTING.md document.

License


Copyright 2013-2023 Prismic <[email protected]> (https://prismic.io)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.