Hyperdrive

Hyperdrive stores filesystem metadata in a Hyperbee and file contents in a blob store, typically backed by one Corestore. Use this page for the instance surface; use the linked how-to guides for end-to-end replication flows.

Install

npm i hyperdrive

Quickstart

import Corestore from 'corestore'
import Hyperdrive from 'hyperdrive'

const store = new Corestore('./storage')
const drive = new Hyperdrive(store)

await drive.ready()

await drive.put('/hello.txt', Buffer.from('hello world'), {
  metadata: { type: 'text/plain' }
})

const buffer = await drive.get('/hello.txt')
const entry = await drive.entry('/hello.txt')

console.log(buffer.toString())
console.log(entry?.value.metadata)

await drive.close()

API Reference

Constructor and lifecycle

new Hyperdrive(store, [key])

API definition on GitHub

• Signature: new Hyperdrive(store, [key]) (GitHub)
• Parameters: store is the Corestore used for metadata and blob storage; key optionally opens an existing drive by public key instead of using the default named core. (GitHub)
• Returns: A Hyperdrive instance. (GitHub)
• Example:

const drive = new Hyperdrive(store, key)
await drive.ready()

await drive.ready()

API definition on GitHub

• Signature: await drive.ready() (GitHub)
• Parameters: None. (GitHub)
• Returns: A promise that resolves when synchronous properties such as drive.discoveryKey are safe to read. (GitHub)
• Example:

await drive.ready()
console.log(drive.discoveryKey)

await drive.close()

API definition on GitHub

• Signature: await drive.close() (GitHub)
• Parameters: None. (GitHub)
• Returns: A promise that resolves after the drive and its underlying storage objects are closed. (GitHub)
• Example:

await drive.close()

await drive.purge()

API definition on GitHub

• Signature: await drive.purge() (GitHub)
• Parameters: None. (GitHub)
• Returns: A promise that resolves after both the metadata core and blob storage are removed from local storage. (GitHub)
• Example:

await drive.purge()

Drive properties

drive.corestore

API definition on GitHub

• Returns: The Corestore instance backing the drive. (GitHub)

drive.db

API definition on GitHub

• Returns: The underlying Hyperbee that stores the drive's directory structure and entry metadata. (GitHub)

drive.core

API definition on GitHub

• Returns: The Hypercore used by drive.db. (GitHub)

drive.id

API definition on GitHub

• Returns: A z-base-32 string identifier derived from the drive's public key. (GitHub)

drive.key

API definition on GitHub

• Returns: The public key of the metadata Hypercore backing the drive. (GitHub)

drive.discoveryKey

API definition on GitHub

• Returns: The discovery key derived from drive.key, typically used as a Hyperswarm topic. (GitHub)

drive.contentKey

API definition on GitHub

• Returns: The public key of the Hyperblobs instance that stores file contents. (GitHub)

drive.writable

API definition on GitHub

• Returns: true when the current instance can mutate entries in the drive. (GitHub)

drive.readable

API definition on GitHub

• Returns: true when the instance can still read data; becomes false after close(). (GitHub)

drive.version

API definition on GitHub

• Returns: The current drive version number, incremented as filesystem mutations are committed. (GitHub)

drive.supportsMetadata

API definition on GitHub

• Returns: true. Hyperdrive always supports entry metadata. (GitHub)

Files

await drive.put(path, buffer, [options])

API definition on GitHub

• Signature: await drive.put(path, buffer, [options]) (GitHub)
• Parameters: path is the absolute drive path to write; buffer is the file content; options matches drive.createWriteStream(...) and supports executable and metadata. (GitHub)
• Returns: A promise that resolves after the file entry and blob are committed. (GitHub)
• Example:

await drive.put('/docs/readme.txt', Buffer.from('hello'))

const buffer = await drive.get(path, [options])

API definition on GitHub

• Signature: const buffer = await drive.get(path, [options]) (GitHub)
• Parameters: path is the file path to read; options.wait waits for remote blocks and options.timeout bounds that wait in milliseconds. (GitHub)
• Returns: A Buffer for the file contents, or null if the file is missing or the path is a symlink. (GitHub)
• Example:

const buffer = await drive.get('/docs/readme.txt')
console.log(buffer?.toString())

const entry = await drive.entry(path, [options])

API definition on GitHub

• Signature: const entry = await drive.entry(path, [options]) (GitHub)
• Parameters: path is the path to inspect; options.follow follows symlinks, while wait and timeout control remote reads. (GitHub)
• Returns: The current entry object, including seq, key, and value metadata, or null when no entry exists. (GitHub)
• Example:

const entry = await drive.entry('/docs/readme.txt')
console.log(entry?.value.metadata)

const exists = await drive.exists(path)

API definition on GitHub

• Signature: const exists = await drive.exists(path) (GitHub)
• Parameters: path is the path to test. (GitHub)
• Returns: true if an entry exists at that path, otherwise false. (GitHub)
• Example:

const exists = await drive.exists('/docs/readme.txt')

await drive.has(path)

API definition on GitHub

• Signature: await drive.has(path) (GitHub)
• Parameters: path is the file path to check. (GitHub)
• Returns: true when the data for that path is already stored locally. (GitHub)
• Example:

const hasLocalData = await drive.has('/docs/readme.txt')

await drive.del(path)

API definition on GitHub

• Signature: await drive.del(path) (GitHub)
• Parameters: path is the file path to remove. (GitHub)
• Returns: A promise that resolves after the entry is deleted from the drive. (GitHub)
• Example:

await drive.del('/docs/old.txt')

const cleared = await drive.clear(path, [options])

API definition on GitHub

• Signature: const cleared = await drive.clear(path, [options]) (GitHub)
• Parameters: path is the file path whose blob data should be discarded locally; options.diff includes a byte-count diff in the return value. (GitHub)
• Returns: Information about cleared bytes when diff is enabled; otherwise null. (GitHub)
• Example:

await drive.clear('/videos/demo.mp4', { diff: true })

const cleared = await drive.clearAll([options])

API definition on GitHub

• Signature: const cleared = await drive.clearAll([options]) (GitHub)
• Parameters: options.diff includes a byte-count diff in the return value. (GitHub)
• Returns: Information about cleared bytes when diff is enabled; otherwise null. (GitHub)
• Example:

await drive.clearAll({ diff: true })

await drive.symlink(path, linkname)

API definition on GitHub

• Signature: await drive.symlink(path, linkname) (GitHub)
• Parameters: path is the symlink entry to create; linkname is the destination path inside the drive. (GitHub)
• Returns: A promise that resolves after the symlink entry is written. (GitHub)
• Example:

await drive.symlink('/images/logo.shortcut', '/images/logo.png')

const rs = drive.createReadStream(path, [options])

API definition on GitHub

• Signature: const rs = drive.createReadStream(path, [options]) (GitHub)
• Parameters: path is the file path to stream; options.start, end, and length select a byte range, while wait and timeout control remote reads. (GitHub)
• Returns: A readable stream for the blob at path. (GitHub)
• Example:

for await (const chunk of drive.createReadStream('/hello.txt')) {
  console.log(chunk)
}

const ws = drive.createWriteStream(path, [options])

API definition on GitHub

• Signature: const ws = drive.createWriteStream(path, [options]) (GitHub)
• Parameters: path is the file path to write; options.executable marks the file executable and options.metadata stores arbitrary JSON metadata. (GitHub)
• Returns: A writable stream that commits the file when closed. (GitHub)
• Example:

const ws = drive.createWriteStream('/notes.txt')
ws.end('hello from a stream')

Directories and listings

const stream = drive.list(folder, [options])

API definition on GitHub

• Signature: const stream = drive.list(folder, [options]) (GitHub)
• Parameters: folder scopes the prefix to list; options.recursive controls descent, options.ignore skips names, and options.wait blocks for remote metadata. (GitHub)
• Returns: A stream of full entry records under the requested folder prefix. (GitHub)
• Example:

for await (const entry of drive.list('/images')) {
  console.log(entry.key)
}

const stream = drive.readdir(folder, [options])

API definition on GitHub

• Signature: const stream = drive.readdir(folder, [options]) (GitHub)
• Parameters: folder is the directory to enumerate; options.wait waits for remote metadata before yielding names. (GitHub)
• Returns: A stream of child paths under the requested folder. (GitHub)
• Example:

for await (const name of drive.readdir('/images')) {
  console.log(name)
}

const stream = await drive.entries([range], [options])

API definition on GitHub

• Signature: const stream = await drive.entries([range], [options]) (GitHub)
• Parameters: range limits the key space to read; options follows the same stream options as the underlying Hyperbee read stream. (GitHub)
• Returns: A read stream of drive entries in key order. (GitHub)
• Example:

for await (const entry of await drive.entries()) {
  console.log(entry.key)
}

const comparison = drive.compare(entryA, entryB)

API definition on GitHub

• Signature: const comparison = drive.compare(entryA, entryB) (GitHub)
• Parameters: entryA and entryB are entry objects returned by Hyperdrive. (GitHub)
• Returns: 0 when the entries match, 1 when entryA is older, and -1 when entryB is older. (GitHub)
• Example:

const comparison = drive.compare(currentEntry, previousEntry)

const watcher = drive.watch([folder])

API definition on GitHub

• Signature: const watcher = drive.watch([folder]) (GitHub)
• Parameters: folder optionally narrows change detection to a subtree; defaults to /. (GitHub)
• Returns: An async iterator that yields [current, previous] snapshots. The watcher also exposes await watcher.ready() and await watcher.destroy(). (GitHub)
• Example:

const watcher = drive.watch('/docs')
await watcher.ready()

for await (const [current, previous] of watcher) {
  console.log(previous.version, '->', current.version)
  break
}

await watcher.destroy()

Versions and batched mutations

const batch = drive.batch()

API definition on GitHub

• Signature: const batch = drive.batch() (GitHub)
• Parameters: None. (GitHub)
• Returns: A batch object with the same mutation interface as drive, allowing multiple writes to be staged atomically. (GitHub)
• Example:

const batch = drive.batch()
await batch.put('/a.txt', Buffer.from('a'))
await batch.put('/b.txt', Buffer.from('b'))
await batch.flush()

await batch.flush()

API definition on GitHub

• Signature: await batch.flush() (GitHub)
• Parameters: None. (GitHub)
• Returns: A promise that resolves when the staged batch mutations are committed to the underlying drive. (GitHub)
• Example:

const batch = drive.batch()
await batch.del('/old.txt')
await batch.flush()

const snapshot = drive.checkout(version)

API definition on GitHub

• Signature: const snapshot = drive.checkout(version) (GitHub)
• Parameters: version is the earlier drive version to open. (GitHub)
• Returns: A read-only snapshot of that version of the drive. (GitHub)
• Example:

const snapshot = drive.checkout(10)
const buffer = await snapshot.get('/hello.txt')

const stream = drive.diff(version, folder, [options])

API definition on GitHub

• Signature: const stream = drive.diff(version, folder, [options]) (GitHub)
• Parameters: version is the baseline version to compare against; folder scopes the diff to one subtree; options passes through to the diff stream. (GitHub)
• Returns: A stream of { left, right } objects describing shallow changes between version and the current drive version. (GitHub)
• Example:

for await (const change of drive.diff(10, '/docs')) {
  console.log(change.left, change.right)
}

await drive.truncate(version, [options])

API definition on GitHub

• Signature: await drive.truncate(version, [options]) (GitHub)
• Parameters: version is the drive version to roll back to; options.blobs can be provided when the matching blob length is already known. (GitHub)
• Returns: A promise that resolves after the drive is truncated to that earlier state. (GitHub)
• Example:

await drive.truncate(10)

Replication, downloads, and blob access

const mirror = drive.mirror(out, [options])

API definition on GitHub

• Signature: const mirror = drive.mirror(out, [options]) (GitHub)
• Parameters: out is another drive-like destination such as Localdrive; options are forwarded to the underlying Mirrordrive instance. (GitHub)
• Returns: A MirrorDrive instance. Call await mirror.done() to wait for the copy to finish. (GitHub)
• Example:

const mirror = drive.mirror(localdrive)
await mirror.done()

const download = drive.download(folder, [options])

API definition on GitHub

• Signature: const download = drive.download(folder, [options]) (GitHub)
• Parameters: folder scopes which subtree to fetch; options match drive.list(...). (GitHub)
• Returns: A Download handle for blob downloads. Use await download.done() to wait for completion or download.destroy() to cancel. (GitHub)
• Example:

const download = drive.download('/images')
await download.done()

const download = await drive.downloadDiff(version, folder, [options])

API definition on GitHub

• Signature: const download = await drive.downloadDiff(version, folder, [options]) (GitHub)
• Parameters: version is the historical version to compare; folder scopes the subtree; options match drive.list(...). (GitHub)
• Returns: A Download handle for blobs that exist in drive.checkout(version) but not in the current drive state. (GitHub)
• Example:

const download = await drive.downloadDiff(10, '/images')
await download.done()

const download = await drive.downloadRange(dbRanges, blobRanges)

API definition on GitHub

• Signature: const download = await drive.downloadRange(dbRanges, blobRanges) (GitHub)
• Parameters: dbRanges selects metadata ranges and blobRanges selects blob ranges, using the range format accepted by Hypercore. (GitHub)
• Returns: A Download handle for the requested metadata and blob ranges. (GitHub)
• Example:

const download = await drive.downloadRange([{ start: 0, end: 10 }], [])
await download.done()

const done = drive.findingPeers()

API definition on GitHub

• Signature: const done = drive.findingPeers() (GitHub)
• Parameters: None. (GitHub)
• Returns: A callback that should be invoked when the current peer-discovery pass finishes, allowing pending updates to unblock. (GitHub)
• Example:

const done = drive.findingPeers()
swarm.flush().then(done, done)

const stream = drive.replicate(isInitiatorOrStream)

API definition on GitHub

• Signature: const stream = drive.replicate(isInitiatorOrStream) (GitHub)
• Parameters: Pass a replication stream or the initiator/options form accepted by the underlying Corestore replication API. (GitHub)
• Returns: The replication stream for the drive and its loaded backing data. (GitHub)
• Example:

swarm.on('connection', (socket) => drive.replicate(socket))

const updated = await drive.update([options])

API definition on GitHub

• Signature: const updated = await drive.update([options]) (GitHub)
• Parameters: options.wait can force a blocking wait for a newer version. (GitHub)
• Returns: A boolean indicating whether the drive observed a new version. (GitHub)
• Example:

const done = drive.findingPeers()
swarm.flush().then(done, done)
const updated = await drive.update()

const blobs = await drive.getBlobs()

API definition on GitHub

• Signature: const blobs = await drive.getBlobs() (GitHub)
• Parameters: None. (GitHub)
• Returns: The Hyperblobs instance storing file contents for the drive. (GitHub)
• Example:

const blobs = await drive.getBlobs()
const entry = await drive.entry('/hello.txt')
const buffer = await blobs.get(entry.value.blob)

const blobsLength = await drive.getBlobsLength(checkout)

API definition on GitHub

• Signature: const blobsLength = await drive.getBlobsLength(checkout) (GitHub)
• Parameters: checkout optionally selects the drive version whose blob length should be resolved. (GitHub)
• Returns: The Hyperblobs length associated with that version of the drive. (GitHub)
• Example:

const blobsLength = await drive.getBlobsLength()

See also

• Create a full peer-to-peer filesystem with Hyperdrive — end-to-end filesystem replication walkthrough.
• Work with many Hypercores using Corestore — recommended pattern when one app manages multiple drives or related cores.
• Localdrive — map a Hyperdrive-like API onto the local filesystem.
• Mirrordrive — sync between Hyperdrive and other drive-like destinations.
• Corestore — shared storage and replication manager for drive metadata and content.
• Hyperbee — Hyperdrive uses a Hyperbee internally for metadata indexing.
• Drives — CLI tool for creating, mirroring, and seeding Hyperdrives.