Browser Client of TSRPC

TSRPC is a TypeScript RPC framework with runtime type checking and binary serialization. See more detail at https://github.com/k8w/tsrpc.

Official site: https://tsrpc.cn

Introduction

HttpClient is using XMLHttpRequest, and WebSocketClient is using WebSocket of browser. Platform adapted to XMLHttpRequest and WebSocket (like ReactNative) can also use this library.

Usage

1import { HttpClient } from 'tsrpc-browser';
2import { serviceProto } from './shared/protocols/serviceProto';
3
4// Create the Client
5let client = new HttpClient(serviceProto, {
6    server: 'http://127.0.0.1:3000',
7    logger: console
8});
9
10async function yourFunc() {
11    // Call API
12    let ret = await client.callApi('Hello', {
13        name: 'World'
14    });
15
16    // Error: ret.err is TsrpcError
17    if (!ret.isSucc) {
18        alert('Error: ' + ret.err.message);
19        return;
20    }
21
22    // Success: ret.res is ResHello
23    alert('Success: ' + ret.res.reply);
24}

Browser Support

The library is compiled to target ES2015, so if you need legacy browser support, you can use Babel to transform the final code to ES5. After that it can support all these browser:

• IE8+
• Chrome
• Firefox
• Safari
• etc...

Caution

1. To support Internet Explorer, you should import es6-promise polyfill by yourself.
2. WebSocket only support IE10+.