OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / secure-prompt / api-extract.json

51 lines · json ref:
{
  "repo": "secure-prompt",
  "timestamp": "2026-01-16T23:56:27.978Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "function"
      }
    ],
    "classes": [],
    "functions": [
      {
        "name": "prompt"
      },
      {
        "name": "init"
      },
      {
        "name": "doPrompt"
      },
      {
        "name": "done"
      }
    ]
  },
  "readme": {
    "content": "# secure-prompt\n\nSecurely prompt stdio using secure buffers\n\n```\nnpm install secure-prompt\n```\n\n## Usage\n\n``` js\nconst prompt = require('secure-prompt')\nconst buffer = await prompt() // user input in buffer\n\nconsole.log(buffer) // will crash\nsodium.sodium_mprotect_readonly(buffer)\nconsole.log(buffer) // prints the buffer\n```\n\n## License\n\nApache-2.0\n",
    "sections": [
      "intro",
      "usage",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 1,
    "examples": [
      "npm install secure-prompt"
    ]
  },
  "patterns": [
    "cryptography"
  ]
}