Add a note to close database before deleting it (#47)

devashishdxt · Jul 4, 2024 · 912b7a0 · 912b7a0
1 parent d13651e
commit 912b7a0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/rexie.rs b/src/rexie.rs
@@ -44,7 +44,8 @@ impl Rexie {
         self.database.close();
     }
 
-    /// Deletes a database
+    /// Deletes a database. Note that the future returned by this function doesn't reach completion until the database
+    /// is closed across all tabs in the browser.
     pub async fn delete(name: &str) -> Result<()> {
         Self::builder(name).delete().await
     }

diff --git a/src/rexie_builder.rs b/src/rexie_builder.rs
@@ -35,7 +35,8 @@ impl RexieBuilder {
         Ok(Rexie { database })
     }
 
-    /// Delete the database.
+    /// Delete the database. Note that the future returned by this function doesn't reach completion until the database
+    /// is closed across all tabs in the browser.
     pub async fn delete(self) -> Result<()> {
         let factory = Factory::new()?;
         factory.delete(&self.name)?.await.map_err(Into::into)