Skip to content

Documentation for BlobsServer import is incorrect #225

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

Open
micmath opened this issue Apr 9, 2025 · 0 comments
Open

Documentation for BlobsServer import is incorrect #225

micmath opened this issue Apr 9, 2025 · 0 comments
Labels
type: bug code to address defects in shipped code

Comments

@micmath
Copy link

micmath commented Apr 9, 2025

Referring to: https://github.com/netlify/blobs?tab=readme-ov-file#server-api-reference

The documentation for BlobsServer shows this as the recommended way to import the BlobsServer API:

// tested and failed in v8.1.2
import { BlobsServer } from '@netlify/blobs'

In fact @netlify/blobs does not export BlobsServer so that cannot work.

The way to do this that works is:

// tested and working in v8.1.2
import { BlobsServer } from '@netlify/blobs/server'

This should either be fixed in the documentation or the exports should be fixed to match the documented API.

@micmath micmath added the type: bug code to address defects in shipped code label Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug code to address defects in shipped code
Projects
None yet
Development

No branches or pull requests

1 participant