@mathrunet/masamune/dist/lib/functions/delete_documents.d.ts

Manages packages for the server portion (NodeJS) of the Masamune framework.

/**
 * Loads related collections and deletes data matching the criteria.
 *
 * 関連するコレクションをロードし、条件に一致するデータを削除します。
 *
 * @param collectionPath
 * Specify the path of the collection to be deleted.
 *
 * 削除対象のコレクションのパスを指定します。
 *
 * @param wheres
 * Specifies the conditions under which collections to be deleted are retrieved.
 *
 * 削除対象のコレクションを取得する際の条件を指定します。
 *
 * @param conditions
 * Specify the conditions under which data is to be deleted.
 *
 * データを削除対象とする条件を指定します。
 */
export declare function deleteDocuments({ collectionPath, wheres, conditions, firestoreInstance, }: {
    collectionPath: string;
    wheres?: {
        [key: string]: any;
    }[] | undefined;
    conditions?: {
        [key: string]: any;
    }[] | undefined;
    firestoreInstance: FirebaseFirestore.Firestore;
}): Promise<{
    [key: string]: any;
}>;