OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / autobase-example / api-extract.json

46 lines · json ref:
{
  "repo": "autobase-example",
  "timestamp": "2026-01-16T23:56:15.900Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [],
    "classes": [
      {
        "name": "View"
      }
    ],
    "functions": [
      {
        "name": "onwritable"
      },
      {
        "name": "append"
      }
    ]
  },
  "readme": {
    "content": "# autobase-example\n\nJust a full E2E simple autobase example\n\n```\nnpm install autobase-example\n```\n\nSee other examples of using `autobase` in [`autobase/examples`](https://github.com/holepunchto/autobase/tree/main/examples).\n\n## Usage\n\n```\nnpm install -g autobase-example\nautobase-example -h # prints help\n```\n\n### Walkthrough\n\n1. Run the bootstrap peer with swarming enabled:\n\n   ```console\n   autobase-example --swarm\n   ```\n\n   You will see the following:\n   ```\n   Base key <base key>\n   Local key <base key>\n   ```\n   Note that the local key will be the same for the bootstrap.\n2. In another shell, run another peer, named `b`, that will write messages to\n   the autobase via the `--spam` flag. Replace the `<base key>` with the Base\n   key from the bootstrap:\n\n   ```\n   autobase-example --name b --key <base key> --spam 1 --swarm\n   ```\n\n   Similarly this will output a Base key and Local key with the Local key being\n   different this time since it is not the bootstrap node. Following the key",
    "sections": [
      "intro",
      "usage",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 6,
    "examples": [
      "npm install autobase-example",
      "npm install -g autobase-example\nautobase-example -h # prints help",
      "You will see the following:"
    ]
  },
  "patterns": [
    "peer-discovery"
  ]
}