{
  "$schema": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json",
  "id": "opt",
  "path": "/opt",
  "type": "module",
  "module": "opt",
  "title": "`@nodevu/opt`",
  "introducedIn": null,
  "sourceLink": {
    "path": "opt/index.js",
    "url": "https://github.com/cutenode/nodevu/blob/main/opt/index.js"
  },
  "stability": null,
  "added": [],
  "deprecated": [],
  "removed": [],
  "napiVersion": [],
  "changes": [],
  "description": "Builds the options [`@nodevu/core`](core.html) takes, filling in a default for\neach one you leave out.\n\n> \\[!NOTE]\n> This module isn't published to npm yet.\n\nCall it with the options to override:\n\n```js\nconst opt = require('@nodevu/opt');\n\nconst options = opt({\n\turls: { index: 'https://example.com/index.json' },\n});\n```",
  "summary": "Builds the options `@nodevu/core` takes, filling in a default for each one you leave out.",
  "examples": [
    {
      "language": "js",
      "displayName": null,
      "code": "const opt = require('@nodevu/opt');\n\nconst options = opt({\n\turls: { index: 'https://example.com/index.json' },\n});"
    }
  ],
  "children": [
    {
      "kind": "method",
      "id": "optoptions",
      "name": "opt",
      "title": "`opt([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": true,
            "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": "globalThis.fetch",
                "optional": true,
                "rest": false,
                "properties": []
              },
              {
                "name": "now",
                "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": "An ISO 8601 date, or a Luxon `DateTime`.",
                "default": "`DateTime.now()` from Luxon",
                "optional": true,
                "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": "'https://nodejs.org/dist/index.json'",
                    "optional": true,
                    "rest": false,
                    "properties": []
                  },
                  {
                    "name": "schedule",
                    "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 schedule.",
                    "default": "'https://raw.githubusercontent.com/nodejs/Release/master/schedule.json'",
                    "optional": true,
                    "rest": false,
                    "properties": []
                  }
                ]
              }
            ]
          }
        ],
        "returns": {
          "type": {
            "text": "Object",
            "links": [
              {
                "name": "Object",
                "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",
                "start": 0,
                "end": 6
              }
            ]
          },
          "description": "The same shape, with every field set."
        }
      },
      "description": "",
      "summary": "",
      "examples": [],
      "children": []
    }
  ]
}