OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / tiny-http-native / api-extract.json

55 lines · json ref:
{
  "repo": "tiny-http-native",
  "timestamp": "2026-01-16T23:39:58.581Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [
      {
        "type": "default",
        "name": "class"
      }
    ],
    "classes": [
      {
        "name": "Socket"
      },
      {
        "name": "Server"
      },
      {
        "name": "Request"
      },
      {
        "name": "Response"
      }
    ],
    "functions": [
      {
        "name": "noop"
      }
    ]
  },
  "readme": {
    "content": "# tiny-http-native\n\nTiny HTTP library made purely on libuv and napi.\n\n```\nnpm install tiny-http-native\n```\n\nUseful for embedded devices that only have n-api but not node.\n\nOnly HTTP servers at the moment and current does NOT support server request bodies,\nbut supports most other HTTP features (keep-alive, chunked encoding etc)\nand streaming server responses.\n\n## Usage\n\n``` js\nconst http = require('tiny-http-native')\n\n// same api as node\n\nconst server = http.createServer(function (req, res) {\n  res.statusCode = 200\n  res.setHeader('Content-Length', 10)\n  res.write('hello world!')\n  res.end()\n})\n\nserver.listen(0, function () {\n  console.log('server is bound on', server.address().port)\n})\n```\n\n## License\n\nApache-2.0\n",
    "sections": [
      "intro",
      "usage",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 1,
    "examples": [
      "npm install tiny-http-native"
    ]
  },
  "patterns": [
    "streaming"
  ]
}