@cob/rest-api-wrapper
v2.9.2
Published
Library of functions to simplify the interaction with a CoB server REST API
Downloads
171
Readme
What is @cob/rest-api-wrapper
@cob/rest-api-wrapper is a library of functions to simplify the interaction with a CoB server backend.
It uses part of the available REST API
How to install
In your project directory run:
npm i @cob/rest-api-wrapperAvailable functions
The list of available functions are:
setServer/getServerauthumLoggedinrmDomainSearchrmDefinitionSearchrmDefinitionAggregationrmListDefinitionsrmListDefinitionFieldsrmGetInstancermAddInstancermDeleteInstancedmEquipmentSearch
TypeScript declarations for all of them ship with the package (see types/index.d.ts).
Examples
Checkout the tests directory for use cases for each of the functions:
tests/unit— offline tests, also documenting the exact requests each function makestests/integration— end-to-end use cases against a live server
Development
For contributions to the project checkout README.Development.md
