Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

deleteDatabase.md

51 lines824 Bytes

1---
2id: deleteDatabase
3title: deleteDatabase
4---
5​
6```ts
7function deleteDatabase(
8 name,
9 idbFactory?,
10onBlocked?): Promise<void>;
11```
12​
13Defined in: packages/db/src/indexed-db-wrapper.ts:505
14​
15Deletes an entire IndexedDB database.
16A blocked request stays pending until native success or error.
17​
18Use with caution - this removes the database and all of its object stores and data.
19​
20## Parameters
21​
22### name
23​
24`string`
25​
26The name of the database to delete
27​
28### idbFactory?
29​
30`IDBFactory`
31​
32Optional IDBFactory for testing/mocking
33​
34### onBlocked?
35​
36(`event`) => `void`
37​
38Optional diagnostic callback for native blocked events. The request stays pending.
39​
40## Returns
41​
42`Promise`\<`void`\>
43​
44A promise that resolves when the database is deleted
45​
46## Example
47​
48```typescript
49await deleteDatabase('myApp')
50console.log('Database deleted')
51```