Skip to main content

TWIN Entity Storage Connector MongoDb

Entity Storage connector implementation using MongoDb storage.

Installation​

npm install @twin.org/entity-storage-connector-mongodb

Testing​

The tests developed are functional tests and need an instance of MongoDb up and running. To run MongoDb locally:

docker run -p 27017:27017 --name twin-entity-storage-mongodb --hostname mongo -d mongo

Afterwards you can run the tests as follows:

npm run test

Examples​

Usage of the APIs is shown in the examples docs/examples.md

Reference​

Detailed reference documentation for the API can be found in docs/reference/index.md

Changelog​

The changes between each version can be found in docs/changelog.md