kibana/api_docs/kbn_generate_csv.devdocs.json

{
  "id": "@kbn/generate-csv",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [
      {
        "parentPluginId": "@kbn/generate-csv",
        "id": "def-common.CsvGenerator",
        "type": "Class",
        "tags": [],
        "label": "CsvGenerator",
        "description": [],
        "path": "packages/kbn-generate-csv/src/generate_csv.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/generate-csv",
            "id": "def-common.CsvGenerator.Unnamed",
            "type": "Function",
            "tags": [],
            "label": "Constructor",
            "description": [],
            "signature": [
              "any"
            ],
            "path": "packages/kbn-generate-csv/src/generate_csv.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$1",
                "type": "Object",
                "tags": [],
                "label": "job",
                "description": [],
                "signature": [
                  "Omit<",
                  {
                    "pluginId": "@kbn/generate-csv-types",
                    "scope": "common",
                    "docId": "kibKbnGenerateCsvTypesPluginApi",
                    "section": "def-common.JobParams",
                    "text": "JobParams"
                  },
                  ", \"version\">"
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$2",
                "type": "Object",
                "tags": [],
                "label": "config",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/generate-csv-types",
                    "scope": "common",
                    "docId": "kibKbnGenerateCsvTypesPluginApi",
                    "section": "def-common.CsvConfig",
                    "text": "CsvConfig"
                  }
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$3",
                "type": "Object",
                "tags": [],
                "label": "clients",
                "description": [],
                "signature": [
                  "Clients"
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$4",
                "type": "Object",
                "tags": [],
                "label": "dependencies",
                "description": [],
                "signature": [
                  "Dependencies"
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$5",
                "type": "Object",
                "tags": [],
                "label": "cancellationToken",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/reporting-common",
                    "scope": "common",
                    "docId": "kibKbnReportingCommonPluginApi",
                    "section": "def-common.CancellationToken",
                    "text": "CancellationToken"
                  }
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$6",
                "type": "Object",
                "tags": [],
                "label": "logger",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/logging",
                    "scope": "common",
                    "docId": "kibKbnLoggingPluginApi",
                    "section": "def-common.Logger",
                    "text": "Logger"
                  }
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/generate-csv",
                "id": "def-common.CsvGenerator.Unnamed.$7",
                "type": "Object",
                "tags": [],
                "label": "stream",
                "description": [],
                "signature": [
                  "Writable"
                ],
                "path": "packages/kbn-generate-csv/src/generate_csv.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/generate-csv",
            "id": "def-common.CsvGenerator.generateData",
            "type": "Function",
            "tags": [],
            "label": "generateData",
            "description": [],
            "signature": [
              "() => Promise<",
              {
                "pluginId": "@kbn/reporting-common",
                "scope": "common",
                "docId": "kibKbnReportingCommonPluginApi",
                "section": "def-common.TaskRunResult",
                "text": "TaskRunResult"
              },
              ">"
            ],
            "path": "packages/kbn-generate-csv/src/generate_csv.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}