Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note to close database before deleting it #47

Merged
merged 1 commit into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/rexie.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
3 changes: 2 additions & 1 deletion src/rexie_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading