OverviewFilesCommitsIssuesDocsReleasesPeers

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

173 lines · json ref:
{
  "repo": "tiny-fs-native",
  "timestamp": "2026-01-16T23:39:45.249Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [],
    "classes": [
      {
        "name": "Stats"
      },
      {
        "name": "FileWriteStream"
      },
      {
        "name": "FileReadStream"
      }
    ],
    "functions": [
      {
        "name": "flagsToNumber"
      },
      {
        "name": "modeToNumber"
      },
      {
        "name": "alloc"
      },
      {
        "name": "getReq"
      },
      {
        "name": "onfsresponse"
      },
      {
        "name": "createError"
      },
      {
        "name": "write"
      },
      {
        "name": "writeSync"
      },
      {
        "name": "writev"
      },
      {
        "name": "read"
      },
      {
        "name": "readSync"
      },
      {
        "name": "readv"
      },
      {
        "name": "open"
      },
      {
        "name": "openSync"
      },
      {
        "name": "close"
      },
      {
        "name": "closeSync"
      },
      {
        "name": "ftruncate"
      },
      {
        "name": "toNumber"
      },
      {
        "name": "stat"
      },
      {
        "name": "statSync"
      },
      {
        "name": "lstat"
      },
      {
        "name": "lstatSync"
      },
      {
        "name": "fstat"
      },
      {
        "name": "fstatSync"
      },
      {
        "name": "mkdirp"
      },
      {
        "name": "rename"
      },
      {
        "name": "mkdir"
      },
      {
        "name": "rmdir"
      },
      {
        "name": "unlink"
      },
      {
        "name": "readFile"
      },
      {
        "name": "loop"
      },
      {
        "name": "done"
      },
      {
        "name": "closeAndError"
      },
      {
        "name": "readFileSync"
      },
      {
        "name": "writeFile"
      },
      {
        "name": "loop"
      },
      {
        "name": "done"
      },
      {
        "name": "closeAndError"
      },
      {
        "name": "writeFileSync"
      },
      {
        "name": "typeError"
      },
      {
        "name": "noop"
      },
      {
        "name": "promisify"
      },
      {
        "name": "map"
      }
    ]
  },
  "readme": {
    "content": "# tiny-fs-native\n\nNative fs for Javascript\n\n```\nnpm install tiny-fs-native\n```\n\nUseful for embedded devices that only have n-api but not node.\n\n\n## Usage\n\n``` js\nconst fs = require('tiny-fs-native')\n\n// currently supports\n\nfs.open\nfs.close\nfs.unlink\nfs.read\nfs.readv\nfs.write\nfs.writev\nfs.ftruncate\nfs.stat\nfs.fstat\nfs.lstat\nfs.mkdir\nfs.rmdir\nfs.rename\n\nfs.readFile\nfs.writeFile\n\nfs.promises.readFile\nfs.promises.writeFile\nfs.promises.mkdir\nfs.promises.rmdir\nfs.promises.stat\nfs.promises.unlink\n\nfs.createReadStream\nfs.createWriteStream\n\nfs.writeFileSync\nfs.readFileSync\nfs.openSync\nfs.readSync\nfs.writeSync\nfs.statSync\nfs.lstatSync\nfs.fstatSync\nfs.closeSync\n```\n\n## License\n\nApache-2.0\n",
    "sections": [
      "intro",
      "usage",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 1,
    "examples": [
      "npm install tiny-fs-native"
    ]
  },
  "patterns": [
    "streaming"
  ]
}