Raven ScottandCursor
7cb1612e71
Complete manual documentation cleanup for the storage stack and expand category-level guides across the library. Documentation (23 storage modules): - Rewrite Methods sections in all storage-hypercore, storage-hyperbee, storage-autobase, and storage-hyperdrive api.md files from index.js - Remove every "module-specific (see implementation)" placeholder in storage - Fix bitfield-scheduler, bee-batch-write, bee-range-watch, drive-gc-sweep APIs Category READMEs (modules/): - trust-security, consensus-coordination, routing-advanced — tables + hub links - MODULE_CATEGORIES.md typo fix (scaffold tier description) Code: - hyper-p2p-trust-graph: hasEdge(), nodeCount(), getStats with protocol - hyper-p2p-circuit-breaker: listCircuitIds(), reset() - hyper-p2p-distributed-lock: getStats merges metrics + active lock counts Parent workspace (not in this repo) also received doc hubs for all 29 categories in docs/README.md and MODULE_DOC_PASS.md giant-pass tracker. Co-authored-by: Cursor <[email protected]>
hyper-p2p-drive-watch-notify
Path watchers with local callbacks plus gossip drive-change notifications; bridge to hyper-p2p-distributed-event-bus for app-wide fanout. Hyperswarm gossip when topic is set.
Category: Storage (Hyperdrive)
Composes with: hyper-p2p-distributed-event-bus
Protocol: drive-watch-notify/v1
When to use
Drive tree changes must reach remote peers subscribed on the same topic.
When not to use
Local-only file notifications without swarm.
Quick start
const { HyperP2PDriveWatchNotify } = require('hyper-p2p-drive-watch-notify')
const topic = process.argv[2] // 64-char hex or string
const mod = new HyperP2PDriveWatchNotify({ topic })
await mod.ready() // joins swarm when topic set
// ... application logic ...
await mod.close()
Docs
- docs/api.md — constructor, methods, events, errors
- docs/architecture.md — wire types, state, composition
- ../_shared/PRODUCTION.md — production checklist
- ../_shared/DOC_STANDARDS.md — documentation standards
Test
npm install && npm test