Skip to content
This repository has been archived by the owner on Jan 26, 2025. It is now read-only.

AuroraTeam/AuroraRPC-Server

Repository files navigation

AuroraRPC-Server

Caution

This package is moved to AuroraRPC monorepo. Please use @aurora-rpc/server instead.

Description

This is the server implementation for Aurora RPC.
The server is based on the websocket protocol. It uses the ws library.
The client implementation is available in AuroraRPC-Client.

Installation

npm i aurora-rpc-server

Usage

import { Server } from 'aurora-rpc-server';

const debug = false; // Set to true to enable debug output

const server = new Server({
    // websocket server options
    port: 8080,
}, debug);

// --- Create a request handler ---

import { AbstractRequest, ResponseResult } from 'aurora-rpc-server';

class HelloRequest extends AbstractRequest {
    method = "hello"

    invoke(): ResponseResult {
        return "Hello Aurora RPC!";
    }
}

// --- Register request handlers ---

server.registerRequest(new HelloRequest());