OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / autopass / api-extract.json

59 lines · json ref:
{
  "repo": "autopass",
  "timestamp": "2026-01-16T23:39:45.629Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "Autopass"
      }
    ],
    "classes": [
      {
        "name": "AutopassPairer"
      },
      {
        "name": "Autopass"
      },
      {
        "name": "function"
      }
    ],
    "functions": [
      {
        "name": "apply"
      },
      {
        "name": "noop"
      }
    ]
  },
  "readme": {
    "content": "# autopass\n\nDistributed notes/password manager\n\n```sh\nnpm install autopass\n```\n\n> [!NOTE]\n> Autopass needs Corestore 7, our latest major version that is backed by RocksDB for storage and atomicity.\n\n## Usage\n\nFirst choose if you wanna pair or make a new instance.\n\n```js\nimport Autopass from 'autopass'\nimport Corestore from 'corestore'\n\nconst pass = new Autopass(new Corestore('./pass'))\n\nconst inv = await pass.createInvite()\nconsole.log('share to add', inv)\n```\n\nThen invite another instance\n\n```js\nconst pair = Autopass.pair(new Corestore('./another-pass'), inv)\n\nconst anotherPass = await pair.finished()\nawait anotherPass.ready()\n```\n\nWhen paired you can simply start the instance again with the normal constructor.\n\n```js\nawait pass.add('a-note', 'hello this is a note')\n```\n\nThen on the other node you get it out with\n\n```js\nconst note = await pass.get('a-note')\nconsole.log({ note })\n```\n\n## API\n\n#### `pass = new Autopass(new Corestore(path))`\n\nMake a new pass instance.\n\n#### `pass.on('upd",
    "sections": [
      "intro",
      "usage",
      "api",
      "contributors"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 4,
    "examples": [
      "> [!NOTE]\n> Autopass needs Corestore 7, our latest major version that is backed by RocksDB for storage and atomicity.\n\n## Usage\n\nFirst choose if you wanna pair or make a new instance.",
      "Then invite another instance",
      "When paired you can simply start the instance again with the normal constructor."
    ]
  },
  "patterns": [
    "append-only-log",
    "peer-discovery"
  ]
}