Skip to content

Plugin import-export basic usage documentation #15552

@truuman

Description

@truuman

Documentation Issue

The import/export plugin basic usage documentation is wrong. https://payloadcms.com/docs/plugins/import-export#basic-usage

The plugin config expects PluginCollectionConfig[] which is an array of objects, in the documentation the provided collection config is string[].

Additional Details / Proposal

Change

import { buildConfig } from 'payload'
import { importExportPlugin } from '@payloadcms/plugin-import-export'

const config = buildConfig({
  collections: [Pages, Media],
  plugins: [
    importExportPlugin({
      collections: ['users', 'pages'],
      // see below for a list of available options
    }),
  ],
})

export default config

to

import { buildConfig } from 'payload'
import { importExportPlugin } from '@payloadcms/plugin-import-export'

const config = buildConfig({
  collections: [Users, Pages],
  plugins: [
    importExportPlugin({
      collections: [{ slug: 'users' }, { slug: 'pages' }],
      // see below for a list of available options
    }),
  ],
})

export default config

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions