{
"repo": "hypercore-blob-server",
"timestamp": "2026-01-16T23:56:09.531Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {
"file": "index.js",
"exports": [
{
"type": "default",
"name": "class"
}
],
"classes": [
{
"name": "BlobCache"
},
{
"name": "BlobRef"
},
{
"name": "BlobDownloader"
},
{
"name": "BlobMonitor"
},
{
"name": "HypercoreBlobServer"
}
],
"functions": [
{
"name": "teardown"
},
{
"name": "onclose"
},
{
"name": "toInfo"
},
{
"name": "decodeRequest"
},
{
"name": "defaultResolve"
},
{
"name": "parseRange"
},
{
"name": "isWithinRange"
},
{
"name": "noop"
}
]
},
"readme": {
"content": "# hypercore-blob-server\n\nHTTP server for streaming hypercore blobs\n\n```\nnpm install hypercore-blob-server\n```\n\nMore flexible successor to [serve-drive](https://github.com/holepunchto/serve-drive)\n\n## Usage\n\n``` js\nconst BlobServer = require('hypercore-blob-server')\n\n// store should be a corestore\nconst server = new BlobServer(store, options)\n\nawait server.listen()\n\n// To get a link to a blob to\nconst link = server.getLink(key, {\n blob: blobId,\n type: 'image/jpeg'\n})\n\n// supports drive lookups also\nconst link = server.getLink(key, {\n filename: '/foo.js'\n})\n```\n\n## API\n\n#### `const server = new BlobServer(store, options)`\n\n`store` - Corestore instance\n\n`options`:\n```js\n{\n port // defaults to 49833,\n host // defaults to '127.0.0.1',\n token // server token\n protocol // 'http' | 'https'\n}\n```\n\n#### `await server.listen()`\nListen to requests\n\n#### `const link = server.getLink(key, options)`\n\nGenerates the url used to fetch data\n\n`key` - hypercore or hyperdrive key\n\n`options`:\n```js\n{\n",
"sections": [
"intro",
"usage",
"api",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 4,
"examples": [
"npm install hypercore-blob-server",
"## API\n\n#### `const server = new BlobServer(store, options)`\n\n`store` - Corestore instance\n\n`options`:",
"#### `await server.listen()`\nListen to requests\n\n#### `const link = server.getLink(key, options)`\n\nGenerates the url used to fetch data\n\n`key` - hypercore or hyperdrive key\n\n`options`:"
]
},
"patterns": [
"append-only-log",
"binary-encoding",
"streaming"
]
}