Add remove overload to allow for doc removal

This commit is contained in:
Rory Powell 2022-11-21 11:38:37 +00:00
parent 626576dbee
commit 523368655d
2 changed files with 25 additions and 5 deletions

View File

@ -6,6 +6,8 @@ import {
DatabaseOpts, DatabaseOpts,
DatabaseQueryOpts, DatabaseQueryOpts,
DatabasePutOpts, DatabasePutOpts,
Document,
isDocument,
} from "@budibase/types" } from "@budibase/types"
import { getCouchInfo } from "./connections" import { getCouchInfo } from "./connections"
import { directCouchCall } from "./utils" import { directCouchCall } from "./utils"
@ -77,12 +79,23 @@ export class DatabaseImpl implements Database {
return this.updateOutput(() => db.get(id)) return this.updateOutput(() => db.get(id))
} }
async remove(id?: string, rev?: string) { async remove(idOrDoc: string | Document, rev?: string) {
const db = await this.checkSetup() const db = await this.checkSetup()
if (!id || !rev) { let _id: string
let _rev: string
if (isDocument(idOrDoc)) {
_id = idOrDoc._id!
_rev = idOrDoc._rev!
} else {
_id = idOrDoc
_rev = rev!
}
if (!_id || !_rev) {
throw new Error("Unable to remove doc without a valid _id and _rev.") throw new Error("Unable to remove doc without a valid _id and _rev.")
} }
return this.updateOutput(() => db.destroy(id, rev)) return this.updateOutput(() => db.destroy(_id, _rev))
} }
async put(document: AnyDocument, opts?: DatabasePutOpts) { async put(document: AnyDocument, opts?: DatabasePutOpts) {

View File

@ -1,6 +1,6 @@
import PouchDB from "pouchdb" import PouchDB from "pouchdb"
import Nano from "nano" import Nano from "nano"
import { AllDocsResponse, AnyDocument } from "../" import { AllDocsResponse, AnyDocument, Document } from "../"
export type PouchOptions = { export type PouchOptions = {
inMemory?: boolean inMemory?: boolean
@ -44,13 +44,20 @@ export type DatabaseQueryOpts = {
keys?: string[] keys?: string[]
} }
export const isDocument = (doc: any): doc is Document => {
return typeof doc === "object" && doc._id && doc._rev
}
export interface Database { export interface Database {
name: string name: string
exists(): Promise<boolean> exists(): Promise<boolean>
checkSetup(): Promise<Nano.DocumentScope<any>> checkSetup(): Promise<Nano.DocumentScope<any>>
get<T>(id?: string): Promise<T | any> get<T>(id?: string): Promise<T | any>
remove(id: string, rev: string): Promise<Nano.DocumentDestroyResponse> remove(
id: string | Document,
rev?: string
): Promise<Nano.DocumentDestroyResponse>
put( put(
document: AnyDocument, document: AnyDocument,
opts?: DatabasePutOpts opts?: DatabasePutOpts