Write your own
This is the official documentation of the @forestadmin/agent
Node.js agent.
Each Plugin is nothing more than an async function
that can perform customizations at either Agent level, Collection level, or both.
3 parameters are provided:
Name | Description |
---|---|
dataSource (API Reference ↗) | An object that allows customizing the whole agent. It has the same interface than the |
collection (API Reference ↗) | An object that allows customizing the collection that the Plugin was called from ( |
options | Options that are provided to the Plugin. There is no set structure for this parameter, as each Plugin will provide specific mandatory or optional options. |
Making your Plugin act differently depending on the Collection
When making a Plugin, you may want it to generalize to many different Collections.
This can be achieved by adopting different behavior depending on the schema
of the Collection being targeted.
Relevant documentation:
DataSourceSchema ↗ (for Plugins working on Charts)
CollectionSchema ↗ (for all other Plugins)
Last updated