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
• types
• Contemporary API -- use promises & async functions

install

npm i @nichoth/blobs

API

Blobs({ dir:string })

Create a new blobs object.

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.

const hash = await blobs.add('hello')

get: (hash:string, enc?:BufferEncoding) => Promise<string|Buffer>

Return the data at the given hash.

const content = await blobs.get(hash, 'utf8')

example

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:

npm test