@rocketmakers/orbit-storage-services v3.1.3

@rocketmakers/orbit-storage-services

Set of service 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-services/lib/config/environment.generated.d.ts.

Implementation

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

Option #1:

If you only want to register classes as needed, or inject alternative repository layers, you can bootstrap services as you would with any other class.

Option #2:

You can bootstrap storage service classes using the exposed registerStorageServicesIoC() function by following the steps below. This will register all service classes, using injected typeorm repository classes from @rocketmakers/orbit-storage-typeorm (you must install this as a dependency).

// 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);

// Register storage types and services from @rocketmakers/orbit-storage-services
const servicesContainer = await registerStorageServicesIoC(repoContainer);

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