{
  "$schema": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json",
  "id": "fetchindex",
  "path": "/fetchindex",
  "type": "module",
  "module": "fetchindex",
  "title": "`@nodevu/fetchindex`",
  "introducedIn": null,
  "sourceLink": {
    "path": "fetchindex/index.js",
    "url": "https://github.com/cutenode/nodevu/blob/main/fetchindex/index.js"
  },
  "stability": null,
  "added": [],
  "deprecated": [],
  "removed": [],
  "napiVersion": [],
  "changes": [],
  "description": "Fetches the [Node.js release index](https://nodejs.org/dist/index.json), the\nlist of every Node.js release with its date, bundled dependencies, files, and\nLTS and security flags.\n\n```bash\nnpm install @nodevu/fetchindex\n```\n\nIt has no defaults, so pass the `fetch` to use and the URL:\n\n```js\nconst fetchindex = require('@nodevu/fetchindex');\n\nconst index = await fetchindex({\n\tfetch: globalThis.fetch,\n\turls: { index: 'https://nodejs.org/dist/index.json' },\n});\n```",
  "summary": "Fetches the Node.js release index, the list of every Node.js release with its date, bundled dependencies, files, and LTS and security flags.",
  "examples": [
    {
      "language": "bash",
      "displayName": null,
      "code": "npm install @nodevu/fetchindex"
    },
    {
      "language": "js",
      "displayName": null,
      "code": "const fetchindex = require('@nodevu/fetchindex');\n\nconst index = await fetchindex({\n\tfetch: globalThis.fetch,\n\turls: { index: 'https://nodejs.org/dist/index.json' },\n});"
    }
  ],
  "children": [
    {
      "kind": "method",
      "id": "fetchindexoptions",
      "name": "fetchindex",
      "title": "`fetchindex(options)`",
      "scope": "module",
      "overloadOf": null,
      "stability": null,
      "added": [],
      "deprecated": [],
      "removed": [],
      "napiVersion": [],
      "changes": [],
      "signature": {
        "parameters": [
          {
            "name": "options",
            "type": {
              "text": "Object",
              "links": [
                {
                  "name": "Object",
                  "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
                  "start": 0,
                  "end": 6
                }
              ]
            },
            "description": "",
            "default": null,
            "optional": false,
            "rest": false,
            "properties": [
              {
                "name": "fetch",
                "type": {
                  "text": "Function",
                  "links": [
                    {
                      "name": "Function",
                      "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function",
                      "start": 0,
                      "end": 8
                    }
                  ]
                },
                "description": "The `fetch` implementation to use.",
                "default": null,
                "optional": false,
                "rest": false,
                "properties": []
              },
              {
                "name": "urls",
                "type": {
                  "text": "Object",
                  "links": [
                    {
                      "name": "Object",
                      "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
                      "start": 0,
                      "end": 6
                    }
                  ]
                },
                "description": "",
                "default": null,
                "optional": false,
                "rest": false,
                "properties": [
                  {
                    "name": "index",
                    "type": {
                      "text": "string",
                      "links": [
                        {
                          "name": "string",
                          "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type",
                          "start": 0,
                          "end": 6
                        }
                      ]
                    },
                    "description": "The full URL of the release index.",
                    "default": null,
                    "optional": false,
                    "rest": false,
                    "properties": []
                  }
                ]
              }
            ]
          }
        ],
        "returns": {
          "type": {
            "text": "Promise<Object[]>",
            "links": [
              {
                "name": "Promise",
                "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise",
                "start": 0,
                "end": 7
              },
              {
                "name": "Object",
                "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
                "start": 8,
                "end": 14
              }
            ]
          },
          "description": "Fulfills with the parsed index, newest release\nfirst."
        }
      },
      "description": "[`@nodevu/opt`](opt.html) builds options with both set.",
      "summary": "`@nodevu/opt` builds options with both set.",
      "examples": [],
      "children": []
    }
  ]
}