{
  "$schema": "https://doc-kit.nodejs.org/schemas/api-doc/1.0.1.json",
  "id": "translate",
  "path": "/translate",
  "type": "module",
  "module": "translate",
  "title": "`@nodevu/translate`",
  "introducedIn": null,
  "sourceLink": {
    "path": "translate/index.js",
    "url": "https://github.com/cutenode/nodevu/blob/main/translate/index.js"
  },
  "stability": null,
  "added": [],
  "deprecated": [],
  "removed": [],
  "napiVersion": [],
  "changes": [],
  "description": "Translates the terms of the Node.js Package Maintenance working group's\n[package support document](https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md)\nto the aliases [`@nodevu/ranges`](ranges.html) takes.\n\n> \\[!NOTE]\n> This module isn't published to npm yet.\n\nPass the result straight to `ranges()`:\n\n```js\nconst ranges = require('@nodevu/ranges');\nconst translate = require('@nodevu/translate');\n\nconst supported = await ranges(await translate('supported'));\n```",
  "summary": "Translates the terms of the Node.js Package Maintenance working group's package support document to the aliases `@nodevu/ranges` takes.",
  "examples": [
    {
      "language": "js",
      "displayName": null,
      "code": "const ranges = require('@nodevu/ranges');\nconst translate = require('@nodevu/translate');\n\nconst supported = await ranges(await translate('supported'));"
    }
  ],
  "children": [
    {
      "kind": "method",
      "id": "translatealias",
      "name": "translate",
      "title": "`translate(alias)`",
      "scope": "module",
      "overloadOf": null,
      "stability": null,
      "added": [],
      "deprecated": [],
      "removed": [],
      "napiVersion": [],
      "changes": [],
      "signature": {
        "parameters": [
          {
            "name": "alias",
            "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": "A package support term.",
            "default": null,
            "optional": false,
            "rest": false,
            "properties": []
          }
        ],
        "returns": {
          "type": {
            "text": "Promise<string[]>",
            "links": [
              {
                "name": "Promise",
                "href": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise",
                "start": 0,
                "end": 7
              },
              {
                "name": "string",
                "href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type",
                "start": 8,
                "end": 14
              }
            ]
          },
          "description": "Fulfills with the aliases it covers."
        }
      },
      "description": "Rejects with an {Error} for any other term. The terms translate to:\n\n| Term         | Aliases                                               |\n| ------------ | ----------------------------------------------------- |\n| `current`    | `['current']`                                         |\n| `lts_latest` | `['lts/latest']`                                      |\n| `lts`        | `['lts/active', 'lts/maintenance']`                   |\n| `supported`  | `['current', 'lts/active', 'lts/maintenance']`        |\n| `all`        | `['current', 'lts/active', 'lts/maintenance', 'eol']` |",
      "summary": "Rejects with an {Error} for any other term. The terms translate to:",
      "examples": [],
      "children": []
    }
  ]
}