Back-End SDK
The Back-End SDK is a Typescript package of common functions and libraries used in Nodeblocks. It is used as the basis of each of the Blocks used in Nodeblocks, but can also be used on its own as a means to integrate and interface your own custom applications and monoliths with the Nodeblocks ecosystem.
Functionality
| Module | Description |
|---|---|
| adapter | Adapter typescript types and default handlers |
| app | Nodeblocks app configuration (e.g. rate limiting, CORS, Express settings) |
| bucket | Google Cloud/AWS buckets |
| core | Core functionality; Error handling, Logging, AJV validation, Network requests, Authentication |
| crypto | Cryptography functions; Private/Public keys |
| external | Third party services; Mail providers |
| module | Prefab modules used in multiple blocks: Attachments module, Follower module, etc |
| mongo | MongoDB query methods; pagination, connection setup |
| router | Express Routing; typing, helpers, OAuth default routes |
| security | Validators; auth, utility, schema enforcement |
| util | Miscellaneous utility functions; custom fields, status codes, etc |
Developer Guide
A full explanation of all methods and types provided in the Back-End SDK can be found in the TSDocs Reference.