OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / mirror-drive / api-extract.json

71 lines · json ref:
{
  "repo": "mirror-drive",
  "timestamp": "2026-01-16T23:05:19.383Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "class"
      }
    ],
    "classes": [
      {
        "name": "Monitor"
      },
      {
        "name": "MirrorDrive"
      }
    ],
    "functions": [
      {
        "name": "blobLength"
      },
      {
        "name": "same"
      },
      {
        "name": "sizeEquals"
      },
      {
        "name": "metadataEquals"
      },
      {
        "name": "toIgnoreFunction"
      },
      {
        "name": "toArray"
      },
      {
        "name": "noop"
      }
    ]
  },
  "readme": {
    "content": "# mirror-drive\n\nMirror a Hyperdrive or Localdrive into another one\n\n```\nnpm i mirror-drive\n```\n\n## Usage\n\n```js\nimport MirrorDrive from 'mirror-drive'\n\nconst src = new Localdrive('./src')\nconst dst = new Hyperdrive(store)\n\nconst mirror = new MirrorDrive(src, dst)\nconsole.log(mirror.count) // => { files: 0, add: 0, remove: 0, change: 0 }\n\nfor await (const diff of mirror) {\n  console.log(diff) /* {\n    op: 'add',\n    key: '/new-file.txt',\n    bytesRemoved: 0,\n    bytesAdded: 4\n  }*/\n}\n\nconsole.log(mirror.count) // => { files: 1, add: 1, remove: 0, change: 0 }\n```\n\nAnother example:\n\n```js\nconst mirror = new MirrorDrive(src, dst)\n\nconsole.log(mirror.count) // => { files: 0, add: 0, remove: 0, change: 0 }\nawait mirror.done()\nconsole.log(mirror.count) // => { files: 1, add: 1, remove: 0, change: 0 }\n```\n\n## API\n\n#### `const mirror = new MirrorDrive(src, dst, [options])`\n\nCreates a mirror instance to efficiently move `src` drive into `dst` drive.\n\nAvailable `options`:\n\n```js\n{\n  prefix: '/',\n",
    "sections": [
      "intro",
      "usage",
      "api",
      "transformers",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 4,
    "examples": [
      "npm i mirror-drive",
      "import MirrorDrive from 'mirror-drive'\n\nconst src = new Localdrive('./src')\nconst dst = new Hyperdrive(store)\n\nconst mirror = new MirrorDrive(src, dst)\nconsole.log(mirror.count) // => { files: 0, add: 0, remove: 0, change: 0 }\n\nfor await (const diff of mirror) {\n  console.log(diff) /* {\n    op: 'add',\n    key: '/new-file.txt',\n    bytesRemoved: 0,\n    bytesAdded: 4\n  }*/\n}\n\nconsole.log(mirror.count) // => { files: 1, add: 1, remove: 0, change: 0 }",
      "const mirror = new MirrorDrive(src, dst)\n\nconsole.log(mirror.count) // => { files: 0, add: 0, remove: 0, change: 0 }\nawait mirror.done()\nconsole.log(mirror.count) // => { files: 1, add: 1, remove: 0, change: 0 }"
    ]
  },
  "patterns": [
    "streaming"
  ]
}