{
"repo": "hyperblobs",
"timestamp": "2026-01-16T23:39:39.662Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {
"file": "index.js",
"exports": [
{
"type": "default",
"name": "Hyperblobs"
}
],
"classes": [
{
"name": "HyperBlobsBatch"
},
{
"name": "Hyperblobs"
}
],
"functions": []
},
"readme": {
"content": "# hyperblobs\n\nA simple blob store for Hypercore.\n\nEach blob is identified by its unique bounds within the Hypercore, e.g. `{ byteOffset: 0, blockOffset: 0, blockLength: 5, byteLength: 327680 }`, which makes them easy to save and retrieve:\n\n```js\nconst blobs = new Hyperblobs(core)\n// ID is { byteOffset: 0, blockOffset: 0, blockLength: 1, byteLength: 11 }\nconst id = await blobs.put(Buffer.from('hello world', 'utf-8'))\nawait blobs.get(id) // Buffer.from('hello world', 'utf-8')\n```\n\nYou can also get from start/end bounds within a single blob:\n\n```js\nconst blobs = new Hyperblobs(core)\n// ID is { byteOffset: 0, blockOffset: 0, blockLength: 1, byteLength: 11 }\nconst id = await blobs.put(Buffer.from('hello world', 'utf-8'))\nawait blobs.get(id, { start: 1, length: 2 }) // Buffer.from('el', 'utf-8')\n```\n\nIf the blob is large, there's a Streams interface (`createReadStream` and `createWriteStream`) too.\n\n## Installation\n\n```\nnpm i hyperblobs\n```\n\n## API\n\n```js\nconst Hyperblobs = require('hyperblo",
"sections": [
"intro",
"installation",
"api",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 7,
"examples": [
"const blobs = new Hyperblobs(core)\n// ID is { byteOffset: 0, blockOffset: 0, blockLength: 1, byteLength: 11 }\nconst id = await blobs.put(Buffer.from('hello world', 'utf-8'))\nawait blobs.get(id) // Buffer.from('hello world', 'utf-8')",
"const blobs = new Hyperblobs(core)\n// ID is { byteOffset: 0, blockOffset: 0, blockLength: 1, byteLength: 11 }\nconst id = await blobs.put(Buffer.from('hello world', 'utf-8'))\nawait blobs.get(id, { start: 1, length: 2 }) // Buffer.from('el', 'utf-8')",
"npm i hyperblobs"
]
},
"patterns": [
"streaming"
]
}