tsrpc
    TypeScript icon, indicating that this package has built-in type declarations

    3.4.1 • Public • Published

    TSRPC

    EN / 中文

    A TypeScript RPC framework with runtime type checking and binary serialization.

    Official site: https://tsrpc.cn (English version is on the way)

    Features

    • Runtime type checking
    • Binary serialization
    • Pure TypeScript, without any decorater or other language
    • HTTP / WebSocket / and more protocols...
    • Optional backward-compatibility to JSON
    • High performance and reliable, verified by services over 100,000,000 users

    Create Full-stack Project

    npx create-tsrpc-app@latest
    

    Usage

    Define Protocol (Shared)

    export interface ReqHello {
      name: string;
    }
    
    export interface ResHello {
      reply: string;
    }

    Implement API (Server)

    import { ApiCall } from "tsrpc";
    
    export async function ApiHello(call: ApiCall<ReqHello, ResHello>) {
      call.succ({
        reply: 'Hello, ' + call.req.name
      });
    }

    Call API (Client)

    let ret = await client.callApi('Hello', {
        name: 'World'
    });

    Examples

    https://github.com/k8w/tsrpc-examples

    Serialization Algorithm

    The best TypeScript serialization algorithm ever. Without any 3rd-party IDL language (like protobuf), it is fully based on TypeScript source file. Define the protocols directly by your code.

    This is powered by TSBuffer, which is going to be open-source.

    TypeScript has the best type system, with some unique advanced features like union type, intersection type, mapped type, etc.

    TSBuffer may be the only serialization algorithm that support them all.

    API Reference

    See API Reference.

    Install

    npm i tsrpc

    DownloadsWeekly Downloads

    144

    Version

    3.4.1

    License

    MIT

    Unpacked Size

    198 kB

    Total Files

    7

    Last publish

    Collaborators

    • k8w