Transport agnostic and protocol polyglot RPC
This module provides a bi-directional RPC scheme that's independent of the actual transport or protocol being used, allowing you to use multiple message formats at the same time or your own one on multiple transports at the same time. Data structures and error codes are influenced by JsonRPC 2.0, but similarities ends there.
- 100% tests coverage
- Designed for simplicity and minimal size, with no (third-party) dependencies
- Requests and notifications (requests without waiting for response)
- Validation of methods params (if provided)
- Return selialized data, sending it is responsability of developer
- Includes implementations of XmlRpc (only for browser) and JsonRPC 2.0
- XmlRpc in Node.js
Constructor of RPC
instance. methods
is an object with the methods we can
response.
Generates and returns a notification message. Its arguments are the method
to
be invoqued, and zero or more param
eters.
Process the received RPC messages, no matter if they are requests, notifications or responses.
ack
: response ack. Equivalent to JsonRpc 2.0 responseid
field, but defined separately to allow protocols that can have both a response and a reply request in the same messageerror
: response errorid
: request or notification idmethod
: request or notification methodparams
: request or notification paramsresult
: response result
For requests or errored notifications, it returns a sucessful Promise with the
response message, or with undefined
as value for succesful notifications. For
responses, it returns a succesul Promise with undefined
as value, or a failed
one in case we were not expecting the response.
Generates and returns a request message. Its arguments are the method
to
be invoqued, and zero or more param
eters. Returned value always includes a
.then()
method that will be resolved or rejected when the response is received
in the .onMessage
method.
You can also provide a errback
function as last parameter, in that case the
errback
will be called when the response is received, and .then()
method
will be called when the errback
resolves or rejects.
Format the messages to the protocol particular format. Not intended for direct
usage, but to be overwritten by child classes to the specific protocol format.
Default one just only return unmodified data
.
Constructor of RPC
instance. methods
is an object with the methods we can
response.
Constructor of RPC
instance. methods
is an object with the methods we can
response.
https://medium.com/swlh/npm-new-package-json-exports-field-1a7d1f489ccf https://nodejs.org/api/packages.html#packages_subpath_imports
xmldom String objects
as first element, instead docfile https://stackoverflow.com/q/13743250/586382 https://www.w3.org/TR/xml/#sec-prolog-dtd foo interpreted as text node, not as invalid XML (documentElement is null) `Element` doesn't includes `ParentNode.children`, only `Node.childNodes` dom-parser TypeError: Cannot read property 'nodeName' of undefined documentElement https://github.com/ershov-konst/dom-parser/blob/master/lib/Dom.js https://www.npmjs.com/package/dom-parse jsdom xmlshim TypeError: Cannot read property 'nodeName' of null "projects": [ { "displayName": "jsdom" }, { "displayName": "node", "testEnvironment": "node" } ] // import {DOMParser} from 'xmldom' // import 'xmldom-ts' // import domparser from '@journeyapps/domparser' // const {DOMParser} = domparser // import DOMParser from 'dom-parser' // import {DOMParser} from 'xmlshim' nodejs/node#37618 jestjs/jest#11161 nodejs/node#37630 jestjs/jest#10883 jestjs/jest#9771 https://webpack.js.org/guides/tree-shaking/#mark-the-file-as-side-effect-free