OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / bare-media / api-extract.json

36 lines · json ref:
{
  "repo": "bare-media",
  "timestamp": "2026-01-16T23:55:43.255Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js",
      "type": "module"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [],
    "classes": [],
    "functions": []
  },
  "readme": {
    "content": "# bare-media\n\nA set of media apis for Bare\n\n## Install\n\n```\nnpm i bare-media\n```\n\n## Usage\n\n```js\nimport { WorkerClient } from 'bare-media'\nimport { spawn } from 'cross-worker-pear' // or 'cross-worker-bare-kit'\n\nconst worker = new WorkerClient({ spawn })\nconst data = await worker.createImagePreview({ path, maxWidth, maxHeight })\n```\n\n> NOTE: A worker spawns when an operation is requested and it stays running until the parent process is killed.\n\nTerminate the worker:\n\n```js\nworker.close()\n\nworker.onClose = () => {\n  // worker terminated\n}\n```\n\nCall the methods directly without a worker:\n\n```js\nimport { createImagePreview } from 'bare-media/worker/media.js'\n\nconst data = await createImagePreview({ path, maxWidth, maxHeight })\n```\n\n## API\n\n> See [schema.js](shared/spec/schema.js) for the complete reference of parameters\n\n### createImagePreview()\n\nCreate a preview from a media file\n\n| Property    | Type   | Description                                                               |\n| ----",
    "sections": [
      "intro",
      "install",
      "usage",
      "api",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 4,
    "examples": [
      "npm i bare-media",
      "import { WorkerClient } from 'bare-media'\nimport { spawn } from 'cross-worker-pear' // or 'cross-worker-bare-kit'\n\nconst worker = new WorkerClient({ spawn })\nconst data = await worker.createImagePreview({ path, maxWidth, maxHeight })",
      "worker.close()\n\nworker.onClose = () => {\n  // worker terminated\n}"
    ]
  },
  "patterns": []
}