@rocketmakers/orbit-notify-twilio
v2.0.5
Published
> TODO: description
Downloads
176
Keywords
Readme
@rocketmakers/orbit-notify-twilio
Exposes a service class that manages sending twilio SMS 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-twilio/lib/config/environment.generated.d.ts
.
Implementation
When using @rocketmakers/orbit-notify-twilio
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-twilio service classes using the exposed registerTwilioIoC()
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
const coreContainer = registerCoreIoC(logger);
// Register anonymous notification template repository, template service and twilio service
const twilioServiceContainer = await registerTwilioIoC(coreContainer);
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 twilioService
within this package can be found using the link below:
Source code
Source code for this package can be found using the link below:
Contributing docs can be found in the README.md