OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / blind-peer / api-extract.json

55 lines · json ref:
{
  "repo": "blind-peer",
  "timestamp": "2026-01-16T23:56:00.456Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "BlindPeer"
      }
    ],
    "classes": [
      {
        "name": "CoreTracker"
      },
      {
        "name": "WakeupHandler"
      },
      {
        "name": "BlindPeer"
      }
    ],
    "functions": []
  },
  "readme": {
    "content": "# blind-peer\n\nBlind peers help keep hypercores available.\n\nFor the client side responsible for requesting cores be kept by Blind Peers, see [blind-peering](https://github.com/holepunchto/blind-peering).\n\nTo run the server as a CLI, see [blind-peer-cli](https://github.com/holepunchto/blind-peer-cli).\n\n## Installation\n\n```\nnpm install blind-peer\n```\n\n## Usage\n\nto run a blind-peer server, use [blind-peer-cli](https://github.com/holepunchto/blind-peer-cli).\n\n### Using a Blind Peer\n\nTo talk to a blind peer, use [blind-peering](https://github.com/holepunchto/blind-peering)\n\nHere is an example:\n\n```js\nimport BlindPeering from 'blind-peering'\nimport Hyperswarm from 'hyperswarm'\nimport Corestore from 'corestore'\nimport Wakeup from 'protomux-wakeup'\n\nconst store = new Corestore(Pear.config.storage)\nconst swarm = new Hyperswarm()\nconst wakeup = new Wakeup()\n\nconst DEFAULT_BLIND_PEER_KEYS = ['es4n7ty45odd1udfqyi9xz58mrbheuhdnxgdufsn9gz6e5uhsqco'] // replace with your own key\nconst blind = new Blin",
    "sections": [
      "intro",
      "installation",
      "usage",
      "programmatic usage",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 3,
    "examples": [
      "npm install blind-peer",
      "import BlindPeering from 'blind-peering'\nimport Hyperswarm from 'hyperswarm'\nimport Corestore from 'corestore'\nimport Wakeup from 'protomux-wakeup'\n\nconst store = new Corestore(Pear.config.storage)\nconst swarm = new Hyperswarm()\nconst wakeup = new Wakeup()\n\nconst DEFAULT_BLIND_PEER_KEYS = ['es4n7ty45odd1udfqyi9xz58mrbheuhdnxgdufsn9gz6e5uhsqco'] // replace with your own key\nconst blind = new BlindPeering(swarm, store, { wakeup, mirrors: DEFAULT_BLIND_PEER_KEYS })\n\n// Add your autobase\nblind.addAutobaseBackground(autobase1)\n\n// Add another core\nblind.addCore(core1, autobase1.wakeupCapability.key)",
      "const BlindPeer = require('blind-peer')"
    ]
  },
  "patterns": [
    "append-only-log",
    "peer-discovery",
    "stream-multiplexing",
    "binary-encoding"
  ]
}