https://github.com/nichoth/blobs
Content addressed blob storage
https://github.com/nichoth/blobs
Last synced: about 1 year ago
JSON representation
Content addressed blob storage
- Host: GitHub
- URL: https://github.com/nichoth/blobs
- Owner: nichoth
- Archived: true
- Created: 2023-04-26T16:30:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-23T18:00:21.000Z (over 2 years ago)
- Last Synced: 2025-04-19T20:26:06.562Z (over 1 year ago)
- Language: JavaScript
- Size: 162 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blobs 
Store blobs by their content address using the blake2 hash algorithm.
## featuring
* ESM only. Sorry, no common JS, because we are using top level `await`
* compatibility with either Node JS or [SSC](https://github.com/socketsupply/socket)
* types
* Contemporary API -- use promises & `async` functions
## install
```
npm i @nichoth/blobs
```
## API
### `Blobs({ dir:string })`
Create a new `blobs` object.
```js
const blobs = Blobs({ dir: '/hello' })
```
### add: (data:Uint8Array|string) => Promise,
Write the data to a file, and return the hash of the data passed in. The hash string returned here is what you would pass in to `blobs.get`.
```js
const hash = await blobs.add('hello')
```
### get: (hash:string, enc?:BufferEncoding) => Promise
Return the data at the given hash.
```js
const content = await blobs.get(hash, 'utf8')
```
## example
```ts
import { test } from 'tapzero'
import { Blobs } from '@nichoth/blobs'
import path from 'node:path'
import fs from 'node:fs/promises'
import { fileURLToPath } from 'url'
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
let blobs
test('create an instance', t => {
blobs = Blobs({ dir: __dirname })
t.ok(blobs, 'should create a new blobs instance')
t.ok(blobs.add, 'has .add')
t.ok(blobs.get, 'has .get')
})
let hash
test('blobs.add', async t => {
hash = await blobs.add('hello')
t.equal(typeof hash, 'string', 'should return hash as a string')
t.equal(hash, 'GSE7rMWN7m294865pHy7Mws9hvjMqJl-sAvkVvFAyiU',
'should return the expected hash')
const stats = await fs.stat(path.join(__dirname, hash))
t.ok(stats, 'should create the file at the right path')
})
test('blobs.get', async t => {
const content = await blobs.get(hash, 'utf8')
t.ok(content, 'got content')
t.equal(content, 'hello', 'should return a string because we passed "utf8"')
})
```
## test
Test in Node:
```bash
npm test
```