Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pip-services3-rpc-nodex

Remote procedure calls for Pip.Services in Node.js / ES2017

pip.services, microservice, communication, rpc, rest, library

readme

Pip.Services Logo
Remote Procedure Calls for Pip.Services in Node.js / ES2017

This module is a part of the Pip.Services polyglot microservices toolkit.

The rpc module provides the synchronous communication using local calls or the HTTP(S) protocol. It contains both server and client side implementations.

The module contains the following packages:

  • Auth - authentication and authorization components
  • Build - HTTP service factory
  • Clients - mechanisms for retrieving connection settings from the microservice’s configuration and providing clients and services with these settings
  • Connect - helper module to retrieve connections for HTTP-based services and clients
  • Services - basic implementation of services for connecting via the HTTP/REST protocol and using the Commandable pattern over HTTP

Quick links:

Use

Install the NPM package as

npm install pip-services3-rpc-nodex --save

Develop

For development you shall install the following prerequisites:

  • Node.js 8+
  • Visual Studio Code or another IDE of your choice
  • Docker
  • Typescript

Install dependencies:

npm install

Compile the code:

tsc

Run automated tests:

npm test

Generate API documentation:

./docgen.ps1

Before committing changes run dockerized build and test as:

./build.ps1
./test.ps1
./clear.ps1

Contacts

The Node.js version of Pip.Services is created and maintained by:

  • Volodymyr Tkachenko
  • Sergey Seroukhov
  • Mark Zontak

The documentation is written by:

  • Mark Makarychev

changelog

Pip.Services Logo
Remote Procedure Calls for Pip.Services in Node.js / ES2017 Changelog

1.3.3 (2023-08-30)

Bug Fixes

  • Fixed HttpResponseSender sendCreatedResult and sendDeletedResult for null

1.3.2 (2023-02-28)

Features

  • Fixed swithching context for async handlers

1.3.1 (2023-02-16)

Bug Fixes

  • Fixed error with closed response

1.3.0 (2023-02-07)

Features

  • Updated dependencies
  • Added supports for Node 18+

1.2.3 (2022-05-20)

Bug Fixes

  • HttpResponseSender fixed sendError addind error type and category

1.2.2 (2022-03-04)

Bug Fixes

  • services Fixed a bug that allows calls to properly return when an exception is thrown

1.2.1 (2021-11-25)

Bug Fixes

  • services Fixed bug with returning CORS header Access-Control-Allow-Origin

1.2.0 (2021-10-29)

Bug Fixes

  • services Fixed bug with formatting ArraySchema in swagger document

1.2.0 (2021-10-21)

Features

  • services Added RegRxp supporting to interceptors Examples:
    • the interceptor route "/dummies" corresponds to all of this routes "/dummies", "/dummies/check", "/dummies/test"
    • the interceptor route "/dummies$" corresponds only for this route "/dummies". The routes "/dummies/check", "/dummies/test" aren't processing by interceptor Please, don't forgot, route in interceptor always automaticaly concateneted with base route, like this service_base_route + route_in_interceptor. For example, "/api/v1/" - service base route, "/dummies$" - interceptor route, in result will be next expression - "/api/v1/dummies$"

1.1.0 (2021-07-27)

Features

  • services Added configuration of CORS headers to HttpEndpoint

1.0.0 (2021-04-11)

Initial public release