kibana/api_docs/kbn_yarn_lock_validator.devdocs.json

{
  "id": "@kbn/yarn-lock-validator",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/yarn-lock-validator",
        "id": "def-common.findProductionDependencies",
        "type": "Function",
        "tags": [],
        "label": "findProductionDependencies",
        "description": [
          "\nGet a list of the all production dependencies for Kibana by starting with the\ndependencies listed in package.json and then traversing deeply into the transitive\ndependencies as declared by the yarn.lock file."
        ],
        "signature": [
          "(log: ",
          {
            "pluginId": "@kbn/some-dev-log",
            "scope": "common",
            "docId": "kibKbnSomeDevLogPluginApi",
            "section": "def-common.SomeDevLog",
            "text": "SomeDevLog"
          },
          ", yarnLock: ",
          {
            "pluginId": "@kbn/yarn-lock-validator",
            "scope": "common",
            "docId": "kibKbnYarnLockValidatorPluginApi",
            "section": "def-common.YarnLock",
            "text": "YarnLock"
          },
          ") => Map<string, { name: string; version: string; }>"
        ],
        "path": "packages/kbn-yarn-lock-validator/src/find_production_dependencies.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/yarn-lock-validator",
            "id": "def-common.findProductionDependencies.$1",
            "type": "Object",
            "tags": [],
            "label": "log",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/some-dev-log",
                "scope": "common",
                "docId": "kibKbnSomeDevLogPluginApi",
                "section": "def-common.SomeDevLog",
                "text": "SomeDevLog"
              }
            ],
            "path": "packages/kbn-yarn-lock-validator/src/find_production_dependencies.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/yarn-lock-validator",
            "id": "def-common.findProductionDependencies.$2",
            "type": "Object",
            "tags": [],
            "label": "yarnLock",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/yarn-lock-validator",
                "scope": "common",
                "docId": "kibKbnYarnLockValidatorPluginApi",
                "section": "def-common.YarnLock",
                "text": "YarnLock"
              }
            ],
            "path": "packages/kbn-yarn-lock-validator/src/find_production_dependencies.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/yarn-lock-validator",
        "id": "def-common.readYarnLock",
        "type": "Function",
        "tags": [],
        "label": "readYarnLock",
        "description": [
          "\nParse any yarn.lock content into a YarnLock map"
        ],
        "signature": [
          "() => Promise<",
          {
            "pluginId": "@kbn/yarn-lock-validator",
            "scope": "common",
            "docId": "kibKbnYarnLockValidatorPluginApi",
            "section": "def-common.YarnLock",
            "text": "YarnLock"
          },
          ">"
        ],
        "path": "packages/kbn-yarn-lock-validator/src/yarn_lock.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/yarn-lock-validator",
        "id": "def-common.validateDependencies",
        "type": "Function",
        "tags": [],
        "label": "validateDependencies",
        "description": [
          "\nValidates the passed yarn.lock file to ensure that we aren't accidentally reproducing\nspecific scenarios we have tried to remove from the codebase."
        ],
        "signature": [
          "(log: ",
          {
            "pluginId": "@kbn/some-dev-log",
            "scope": "common",
            "docId": "kibKbnSomeDevLogPluginApi",
            "section": "def-common.SomeDevLog",
            "text": "SomeDevLog"
          },
          ", yarnLock: ",
          {
            "pluginId": "@kbn/yarn-lock-validator",
            "scope": "common",
            "docId": "kibKbnYarnLockValidatorPluginApi",
            "section": "def-common.YarnLock",
            "text": "YarnLock"
          },
          ") => Promise<void>"
        ],
        "path": "packages/kbn-yarn-lock-validator/src/validate_yarn_lock.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/yarn-lock-validator",
            "id": "def-common.validateDependencies.$1",
            "type": "Object",
            "tags": [],
            "label": "log",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/some-dev-log",
                "scope": "common",
                "docId": "kibKbnSomeDevLogPluginApi",
                "section": "def-common.SomeDevLog",
                "text": "SomeDevLog"
              }
            ],
            "path": "packages/kbn-yarn-lock-validator/src/validate_yarn_lock.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/yarn-lock-validator",
            "id": "def-common.validateDependencies.$2",
            "type": "Object",
            "tags": [],
            "label": "yarnLock",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/yarn-lock-validator",
                "scope": "common",
                "docId": "kibKbnYarnLockValidatorPluginApi",
                "section": "def-common.YarnLock",
                "text": "YarnLock"
              }
            ],
            "path": "packages/kbn-yarn-lock-validator/src/validate_yarn_lock.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/yarn-lock-validator",
        "id": "def-common.YarnLock",
        "type": "Interface",
        "tags": [],
        "label": "YarnLock",
        "description": [
          "\nParsed yarn.lock file contents mapping `name@versionRange` strings to information from\nthe yarn.lock file that is used to satisfy that request."
        ],
        "path": "packages/kbn-yarn-lock-validator/src/yarn_lock.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/yarn-lock-validator",
            "id": "def-common.YarnLock.Unnamed",
            "type": "IndexSignature",
            "tags": [],
            "label": "[key: string]: { version: string; resolved: string; integrity: string; dependencies?: { [key: string]: string; } | undefined; optionalDependencies?: { [key: string]: string; } | undefined; }",
            "description": [
              "a simple map of `name@versionrange` tags to metadata about a package"
            ],
            "signature": [
              "[key: string]:  { version: string; resolved: string; integrity: string; dependencies?: { [key: string]: string; } | undefined; optionalDependencies?: { [key: string]: string; } | undefined; }"
            ],
            "path": "packages/kbn-yarn-lock-validator/src/yarn_lock.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}