updated collections.import doc comment

pocketbase · Aug 11, 2022 · 9176ed9 · 9176ed9
1 parent 4c0075e
commit 9176ed9
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 1 deletion.
diff --git a/dist/pocketbase.cjs.d.ts b/dist/pocketbase.cjs.d.ts
@@ -366,6 +366,10 @@ declare class Collections extends CrudService<Collection> {
     baseCrudPath(): string;
     /**
      * Imports the provided collections.
+     *
+     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * that are not present in the imported configuration, WILL BE DELETED
+     * (including their related records data)!
      */
     import(collections: Array<Collection>, deleteMissing?: boolean, queryParams?: {}): Promise<true>;
 }

diff --git a/dist/pocketbase.es.d.mts b/dist/pocketbase.es.d.mts
@@ -366,6 +366,10 @@ declare class Collections extends CrudService<Collection> {
     baseCrudPath(): string;
     /**
      * Imports the provided collections.
+     *
+     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * that are not present in the imported configuration, WILL BE DELETED
+     * (including their related records data)!
      */
     import(collections: Array<Collection>, deleteMissing?: boolean, queryParams?: {}): Promise<true>;
 }

diff --git a/dist/pocketbase.es.mjs.map b/dist/pocketbase.es.mjs.map
diff --git a/dist/pocketbase.iife.d.ts b/dist/pocketbase.iife.d.ts
@@ -366,6 +366,10 @@ declare class Collections extends CrudService<Collection> {
     baseCrudPath(): string;
     /**
      * Imports the provided collections.
+     *
+     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * that are not present in the imported configuration, WILL BE DELETED
+     * (including their related records data)!
      */
     import(collections: Array<Collection>, deleteMissing?: boolean, queryParams?: {}): Promise<true>;
 }

diff --git a/dist/pocketbase.umd.d.ts b/dist/pocketbase.umd.d.ts
@@ -366,6 +366,10 @@ declare class Collections extends CrudService<Collection> {
     baseCrudPath(): string;
     /**
      * Imports the provided collections.
+     *
+     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * that are not present in the imported configuration, WILL BE DELETED
+     * (including their related records data)!
      */
     import(collections: Array<Collection>, deleteMissing?: boolean, queryParams?: {}): Promise<true>;
 }

diff --git a/src/services/Collections.ts b/src/services/Collections.ts
@@ -18,6 +18,10 @@ export default class Collections extends CrudService<Collection> {
 
     /**
      * Imports the provided collections.
+     *
+     * If `deleteMissing` is `true`, all local collections and schema fields,
+     * that are not present in the imported configuration, WILL BE DELETED
+     * (including their related records data)!
      */
     async import(collections: Array<Collection>, deleteMissing: boolean = false, queryParams = {}): Promise<true> {
         return this.client.send(this.baseCrudPath() + '/import', {