Installations

npm install msgpack-rpc-lite

Pull Requests

Open

6

Total

13

Closed

4

Merged

3

Issues

Open

1

Total

3

Closed

2

Releases

14

v0.2.0

Published on 23 Mar 2018

v0.1.4

Published on 19 Mar 2018

v0.1.3

Published on 18 Mar 2018

v0.1.2

Published on 18 Mar 2018

v0.1.1

Published on 17 Mar 2018

v0.1.0

Published on 17 Mar 2018

View all 14 releases

Developer

naokikimura

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

8.9.4

NPM Version

5.6.0 Statistics

5 Stars

78 Commits

1 Forks

2 Watching

7 Branches

2 Contributors

Updated on 03 Jun 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

9,138

Last day

-66.7%

1

Compared to previous day

Last week

258.3%

43

Compared to previous week

Last month

163.3%

79

Compared to previous month

Last year

-19.5%

578

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

@types/msgpack-lite msgpack-lite

Dev Dependencies

15

@types/chai @types/mocha @types/node chai codacy-coverage codecov debug istanbul mocha mocha-lcov-reporter nyc portfinder source-map-support ts-node typescript

Versions

msgpack-rpc-lite

Implementation of MessagePack-RPC with msgpack-lite

Usage

createServer([serverOptions][, codecOptions])

Creates a new MessagePack-RPC server.
- serverOptions <Object> See net.createServer([options][, connectionListener])
- codecOptions <Object>
  - encode See Custom Codec Options
  - decode See Custom Codec Options
- Returns: <net.Server>
Server event: method

Emitted when a new connection is made.
- <Array> request parameters.
- <Function> If a request is received, a callback function is passed.
  - To return the results to the client, pass null as the first argument and response parameters as the second argument.
  - If an error occurs, pass it to the first argument.
createClient(port[, host][, timeout][, codecOptions])

Initiates a MessagePack-RPC client.
- port <number> Port the socket should connect to.
- host <string> Host the socket should connect to. Default: 'localhost'
- timeout <number> Sets the socket to timeout after timeout milliseconds of inactivity on the socket. If timeout is 0, then the existing idle timeout is disabled. Default: 0
- codecOptions <Object>
  - encode See Custom Codec Options
  - decode See Custom Codec Options
- Return: <Client>
client.request(method[, ...args])
- method <string>
- Return: <Promise>
client.notify(method[, ...args])
- method <string>
- Return: <Promise>

Examples

Server

1const rpc = require('msgpack-rpc-lite');
2const server = rpc.createServer().on('say', (params, callback) => {
3    const [ message ] = params; 
4    callback(null, `hello ${ message }`);
5});
6server.listen(9199);

Client

1const rpc = require('msgpack-rpc-lite');
2
3const client = rpc.createClient(9199, 'localhost');
4client.request('say', [ 'world' ]).then(([ response ]) => {
5    console.log(response); // hello world
6})

Compatibility Mode

Set true to useraw of encode/decode of Codec-options.

Client

1const codecOptions = { encode: { useraw: true }, decode: { useraw: true } };
2
3const client = rpc.createClient(9199, 'localhost', 0, codecOptions);

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

msgpack-rpc-lite

Installations

Pull Requests

6

13

4

3

Issues

1

3

2

Releases

Developer

naokikimura

Developer Guide

CommonJS

Yes

8.9.4

5.6.0

Statistics

Languages

Total Downloads

9,138

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

msgpack-rpc-lite

Usage

Examples

Compatibility Mode

See also

10

10

0

0

0

0

0

0

0

0

1.7

/10