Quick Start

Installation

To install Simple RPC, simply run the following command in your server project folder or client project folder:

npm install @neko-gong/simple-rpc

Server

For the server side, both ESM and CJS are supported.

Assume you have a folder named rpc where all the modules you want to expose to the client are located.

The file structure should be like this:

project/
  ├── rpc/
  │   ├── user.js
  │   └── file.js
  └── server.js

In the file server.js, you can use the following code to create a server:

ESM

import { createServer } from '@neko-gong/simple-rpc'

const server = createServer()
server.useRpc('./rpc')

await server.start()

CJS

const { createServer } = require('@neko-gong/simple-rpc')

;(async () => {
    const server = createServer()
    server.useRpc('./rpc')

    await server.start()
})()

In the file rpc/user.js, you can create several exported functions:

ESM

export const getById = id => {
    return { id, name: 'John' }
}

export const add = async user => {
    await new Promise(resolve => setTimeout(resolve, 5000))
    return user
}

CJS

const getById = id => {
    return { id, name: 'John' }
}

const add = async user => {
    await new Promise(resolve => setTimeout(resolve, 5000))
    return user
}

module.exports = { getUserById, addUser }

Client

For the client side, you can use Node.js (ESM or CJS) or browser (ESM or UMD).

Using Node.js

ESM

import client from '@neko-gong/simple-rpc/client'

client.settings.host = 'http://localhost:8080'

let user = await client.user.getById(1)
console.log(user)

user = await client.user.add({ id: 2, name: 'Jane' })
console.log(user)

CJS

const { default: client } = require('@neko-gong/simple-rpc/client')

client.settings.host = 'http://localhost:8080'

;(async () => {
    let user = await client.user.getById(1)
    console.log(user)

    user = await client.user.add({ id: 2, name: 'Jane' })
    console.log(user)
})()

For using UMD in browser, access the global variable simpleRpcClient:

<script src="node_modules/@neko-gong/simple-rpc/dist/client-umd.js"></script>

const client = simpleRpcClient.default

const user = await client.user.getById(1)
console.log(user)

To explore more features, please refer to the next sections to know about the APIs of the RPC framework.