# nestjs-json-rpc

> Nestjs JSON RPC 2.0 Controller

Latest version **1.2.0** (published 2022-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install nestjs-json-rpc
pnpm add nestjs-json-rpc
yarn add nestjs-json-rpc
bun add nestjs-json-rpc
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2022-03-01 |
| First published | 2019-10-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 17.4 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Anton Golub |
| Maintainers | qiwibot |
| Keywords | json rpc, json-rpc |

## Links

- npm: https://www.npmjs.com/package/nestjs-json-rpc
- Repository: https://github.com/qiwi/json-rpc
- Homepage: https://github.com/qiwi/json-rpc#readme
- Issues: https://github.com/qiwi/json-rpc/issues
- npm.io page: https://npm.io/package/nestjs-json-rpc

## Dependencies (11)

- [rxjs](https://npm.io/package/rxjs.md) ^7.3.0
- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [@nestjs/core](https://npm.io/package/@nestjs/core.md) ^8.0.5
- [jsonrpc-lite](https://npm.io/package/jsonrpc-lite.md) ^2.2.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.172
- [@nestjs/common](https://npm.io/package/@nestjs/common.md) ^8.0.5
- [@types/express](https://npm.io/package/@types/express.md) ^4.17.13
- [@qiwi/substrate](https://npm.io/package/@qiwi/substrate.md) ^1.20.9
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [expressjs-json-rpc](https://npm.io/package/expressjs-json-rpc.md) 1.5.0
- [@qiwi/json-rpc-common](https://npm.io/package/@qiwi/json-rpc-common.md) 1.1.5

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.2.0 (latest) — 2022-03-01
- 1.1.9 — 2021-08-04
- 1.1.8 — 2020-07-14
- 1.1.7 — 2020-07-07
- 1.1.6 — 2020-06-05
- 1.1.5 — 2020-05-31
- 1.1.4 — 2020-03-31
- 1.1.3 — 2020-03-26
- 1.1.2 — 2020-03-26
- 1.1.1 — 2020-03-25
- 1.1.0 — 2020-03-19
- 1.0.3 — 2020-02-11
- 1.0.2 — 2019-11-25
- 1.0.1 — 2019-11-04
- 1.0.0 — 2019-10-21

## README

# nestjs-json-rpc
Nestjs JSON RPC 2.0 Controller

## Install
```bash
yarn add nestjs-json-rpc
npm add nestjs-json-rpc
```

## Usage
```typescript
import {
  JsonRpcController,
  JsonRpcMethod,
  IJsonRpcId,
  IJsonRpcParams
} from 'nestjs-json-rpc'

@JsonRpcController('/jsonrpc/endpoint')
export class SomeJsonRpcController {
  @JsonRpcMethod('some-method')
  doSomething(@JsonRpcId() id: IJsonRpcId, @JsonRpcParams() params: IJsonRpcParams) {
    const {foo} = params
    
    if (foo === 'bar') {
      return new JsonRpcError(-100, '"foo" param should not be equal "bar"')
    }
    
    return 'ok'
  }
} 
```

## Specification
[https://www.jsonrpc.org/specification](https://www.jsonrpc.org/specification)

---
_Source: https://npm.io/package/nestjs-json-rpc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._