Skip to content

chore: deprecate blockstore-level and datastore-fs #353

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: deprecate blockstore-level and datastore-fs #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb1d9a7
chore: deprecate blockstore-level and datastore-fs
2color Aug 7, 2025
e30a470
chore: remove unnecessary ts comment
2color Aug 7, 2025
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
8 changes: 6 additions & 2 deletions packages/blockstore-level/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# blockstore-level

## ⚠️ Deprecation Warning

**This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.**

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
Expand All @@ -24,9 +28,9 @@ repo and examine the changes made.

-->

A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
⚠️ This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.

N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.

## Example

Expand Down
4 changes: 2 additions & 2 deletions packages/blockstore-level/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/**
* @packageDocumentation
*
* A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
* ⚠️ This package is deprecated. Instead, use `blockstore-fs` in node.js, and `blockstore-idb` in browsers.
*
* N.b. this is here largely for the sake of completeness, in node you should probably use FSDatastore, in browsers you should probably use IDBDatastore.
* A Blockstore implementation that uses a flavour of [Level](https://leveljs.org/) as a backend.
*
* @example
*
Expand Down
6 changes: 6 additions & 0 deletions packages/datastore-fs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# datastore-fs

## ⚠️ Deprecation Warning

**This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.**

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
Expand All @@ -24,6 +28,8 @@ repo and examine the changes made.

-->

⚠️ This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.

A Datastore implementation with a file system backend.

## Example
Expand Down
2 changes: 2 additions & 0 deletions packages/datastore-fs/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/**
* @packageDocumentation
*
* ⚠️ This package is deprecated. Instead, use `datastore-level` in node.js, and `datastore-idb` in browsers.
*
* A Datastore implementation with a file system backend.
*
* @example
Expand Down
1 change: 0 additions & 1 deletion packages/datastore-s3/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@ export class S3Datastore extends BaseDatastore {
return new Uint8Array(buf, 0, buf.byteLength)
}

// @ts-expect-error s3 types define their own Blob as an empty interface
return await toBuffer(data.Body)
} catch (err: any) {
if (err.statusCode === 404) {
Expand Down
Loading