tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: updates types and readme

Browse Source
This commit is contained in:
Jessica Boezwinkle
2023-06-23 16:02:01 +01:00
parent 9182e79c2d
commit f615b8cdf2
3 changed files with 53 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/plugin-sentry/README.md
View File

@@ -16,9 +16,9 @@ This plugin seamlessly integrates [Sentry](https://sentry.io/) with [Payload](ht
1. Import `sentry` from `'@payloadcms/plugin-sentry'`
2. Add it to the `plugins` array of your [Payload config](https://payloadcms.com/docs/configuration/overview)
3. Pass in your Data Source Name (DSN)
3. Pass in your Data Source Name (DSN)
4. Pass [additional options](#additional-options) - *not required*
```js
import { buildConfig } from 'payload/config';
import sentry from '@payloadcms/plugin-sentry';
@@ -48,6 +48,10 @@ export default config;
### Additional Options
- `enabled`: boolean | optional
Set to false to disable the plugin. Defaults to true.
- `init` : ClientOptions | optional
Sentry allows a variety of options to be passed into the Sentry.init() function, see the full list of options [here](https://docs.sentry.io/platforms/node/guides/express/configuration/options).