chore(comment): collectionOptions.duplicator (#1752)

This commit is contained in:
YANG QIA 2023-04-23 18:29:48 +08:00 committed by GitHub
parent 6d693a5ab6
commit 25d2ebf02a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,6 +24,14 @@ type dumpable = 'required' | 'optional' | 'skip';
export interface CollectionOptions extends Omit<ModelOptions, 'name' | 'hooks'> {
name: string;
namespace?: string;
/**
* Used for @nocobase/plugin-duplicator
* @see packages/core/database/src/collection-group-manager.tss
*
* @prop {'required' | 'optional' | 'skip'} dumpable - Determine whether the collection is dumped
* @prop {string[] | string} [with] - Collections dumped with this collection
* @prop {any} [delayRestore] - A function to execute after all collections are restored
*/
duplicator?:
| dumpable
| {