kbn_ci_stats_core.devdocs.json

{
  "id": "@kbn/ci-stats-core",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/ci-stats-core",
        "id": "def-common.parseConfig",
        "type": "Function",
        "tags": [],
        "label": "parseConfig",
        "description": [],
        "signature": [
          "(log: ",
          {
            "pluginId": "@kbn/some-dev-log",
            "scope": "common",
            "docId": "kibKbnSomeDevLogPluginApi",
            "section": "def-common.SomeDevLog",
            "text": "SomeDevLog"
          },
          ") => ",
          {
            "pluginId": "@kbn/ci-stats-core",
            "scope": "common",
            "docId": "kibKbnCiStatsCorePluginApi",
            "section": "def-common.Config",
            "text": "Config"
          },
          " | undefined"
        ],
        "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ci-stats-core",
            "id": "def-common.parseConfig.$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-ci-stats-core/src/ci_stats_config.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/ci-stats-core",
        "id": "def-common.CiStatsMetadata",
        "type": "Interface",
        "tags": [],
        "label": "CiStatsMetadata",
        "description": [
          "Container for metadata that can be attached to different ci-stats objects"
        ],
        "path": "packages/kbn-ci-stats-core/src/ci_stats_metadata.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ci-stats-core",
            "id": "def-common.CiStatsMetadata.Unnamed",
            "type": "IndexSignature",
            "tags": [],
            "label": "[key: string]: string | number | boolean | string[] | undefined",
            "description": [
              "\nArbitrary key-value pairs which can be attached to CiStatsTiming and CiStatsMetric\nobjects stored in the ci-stats service"
            ],
            "signature": [
              "[key: string]:  string | number | boolean | string[] | undefined"
            ],
            "path": "packages/kbn-ci-stats-core/src/ci_stats_metadata.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/ci-stats-core",
        "id": "def-common.Config",
        "type": "Interface",
        "tags": [],
        "label": "Config",
        "description": [
          "\nInformation about how CiStatsReporter should talk to the ci-stats service. Normally\nit is read from a JSON environment variable using the `parseConfig()` function\nexported by this module."
        ],
        "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/ci-stats-core",
            "id": "def-common.Config.apiToken",
            "type": "string",
            "tags": [],
            "label": "apiToken",
            "description": [
              "ApiToken necessary for writing build data to ci-stats service"
            ],
            "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/ci-stats-core",
            "id": "def-common.Config.buildId",
            "type": "string",
            "tags": [],
            "label": "buildId",
            "description": [
              "\nuuid which should be obtained by first creating a build with the\nci-stats service and then passing it to all subsequent steps"
            ],
            "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}