@rocketmakers/orbit-notify-sendgrid v3.1.3

@rocketmakers/orbit-notify-sendgrid

Exposes a service class that manages sending sendgrid email notifications.

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-notify-sendgrid/lib/config/environment.generated.d.ts.

Implementation

When using @rocketmakers/orbit-notify-sendgrid 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 notify-sendgrid service classes using the exposed registerSendgridIoC() function by following the steps below. This will register all service classes, using (you must install this as a dependency).

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

// Register anonymous notification template repository, template service and sendgrid service
const sendgridServiceContainer = await registerSendGridIoC(coreContainer);

// Init template cache for sendgrid during bootstrap
await sendgridServiceContainer.get('sendgridTemplateService').initCache();

Details on template repository setup can be found in the @rocketmakers/orbit-template-http-repository documentation.

N.B. the format for the provided rootUrl should be https://<remote-repo-provider>.com/<organisation>/<project>/raw/<branch-name>. For example: https://gitlab.com/rocketmakers/spike-template-source/raw/master

Docs

Hosted docs covering types, interfaces and the sendgridService 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