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

chore: updates payload cloud plugin docs (#8943)

Browse Source 
Documentation updated to match current implementation.

Original Doc:
```ts
import { payloadCloud } from '@payloadcms/payload-cloud'
```

Current:
```ts
import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
```

---

References in docs have been updated.
This commit is contained in:
Kendell Joseph
2024-10-30 12:52:56 -04:00
committed by GitHub
parent f4041ce6e2
commit 61b4f2efd7
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/payload-cloud/README.md
View File

@@ -21,11 +21,11 @@ Add the plugin to your Payload config
`yarn add @payloadcms/payload-cloud` `yarn add @payloadcms/payload-cloud`
```ts ```ts
import { payloadCloud } from '@payloadcms/payload-cloud' import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
import { buildConfig } from 'payload' import { buildConfig } from 'payload'
export default buildConfig({ export default buildConfig({
plugins: [payloadCloud()], plugins: [payloadCloudPlugin()],
// rest of config // rest of config
}) })
``` ```
@@ -41,7 +41,7 @@ After configuring, ensure that the `from` email address is from a domain you hav
If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so. If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
```ts ```ts
payloadCloud({ payloadCloudPlugin({
storage: false, // Disable file storage storage: false, // Disable file storage
email: false, // Disable email delivery email: false, // Disable email delivery
uploadCaching: false, // Disable upload caching uploadCaching: false, // Disable upload caching
@@ -53,7 +53,7 @@ payloadCloud({
If you wish to configure upload caching on a per-collection basis, you can do so by passing in a keyed object of collection names. By default, all collections will be cached for 24 hours (86400 seconds). The cache is invalidated when an item is updated or deleted. If you wish to configure upload caching on a per-collection basis, you can do so by passing in a keyed object of collection names. By default, all collections will be cached for 24 hours (86400 seconds). The cache is invalidated when an item is updated or deleted.
```ts ```ts
payloadCloud({ payloadCloudPlugin({
uploadCaching: { uploadCaching: {
maxAge: 604800, // Override default maxAge for all collections maxAge: 604800, // Override default maxAge for all collections
collection1Slug: { collection1Slug: {