@rocketmakers/orbit-storage-typeorm

Set of repository-layer classes required in the orbit storage microservice.

Environment config

Once installed as a dependency, any env vars required by this package will be listed as properties of the @rocketmakers/environment generated class found at node_modules/@rocketmakers/orbit-storage-typeorm/lib/config/environment.generated.d.ts.

Implementation

When using @rocketmakers/orbit-storage-typeorm there are two options to register service classes with your ioc framework.

Option #1:

If you only want to register individual classes as needed, you can bootstrap repositories as you would with any other class.

Option #2:

You can bootstrap storage repository classes using the exposed registerStorageTypeormIoC() function by following the steps below.

// Register core types and services from @rocketmakers/orbit-core
const coreContainer = registerCoreIoC(logger);

// Register types and repository classes from @rocketmakers/orbit-storage-typeorm
const repoContainer = registerStorageTypeormIoC(coreContainer);

Docs

Hosted docs covering types, interfaces and all service class/method signatures within this package can be found using the link below:

Documentation

Source code

Source code for this package can be found using the link below:

Source code

Contributing docs can be found in the README.md