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

TSRPC Client for browser
https://github.com/k8w/tsrpc-browser

framework fullstack k8w rpc tsrpc typescript

Last synced: 24 days ago
JSON representation

TSRPC Client for browser

• Host: GitHub
• URL: https://github.com/k8w/tsrpc-browser
• Owner: k8w
• License: mit
• Created: 2017-09-29T06:14:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T12:38:02.000Z (7 months ago)
• Last Synced: 2024-11-07T13:41:26.852Z (7 months ago)
• Topics: framework, fullstack, k8w, rpc, tsrpc, typescript
• Language: TypeScript
• Size: 396 KB
• Stars: 9
• Watchers: 3
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](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

```ts

import { HttpClient } from 'tsrpc-browser';

import { serviceProto } from './shared/protocols/serviceProto';

// Create the Client

let client = new HttpClient(serviceProto, {

    server: 'http://127.0.0.1:3000',

    logger: console

});

async function yourFunc() {

    // Call API

    let ret = await client.callApi('Hello', {

        name: 'World'

    });

    // Error: ret.err is TsrpcError

    if (!ret.isSucc) {

        alert('Error: ' + ret.err.message);

        return;

    }

    // Success: ret.res is ResHello

    alert('Success: ' + ret.res.reply);

}

```

## 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+.