kibana/api_docs/kbn_timerange.devdocs.json

{
  "id": "@kbn/timerange",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/timerange",
        "id": "def-common.getDateISORange",
        "type": "Function",
        "tags": [],
        "label": "getDateISORange",
        "description": [],
        "signature": [
          "({ from, to }: { from: string; to: string; }) => { startDate: string; endDate: string; }"
        ],
        "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/timerange",
            "id": "def-common.getDateISORange.$1",
            "type": "Object",
            "tags": [],
            "label": "{ from, to }",
            "description": [],
            "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getDateISORange.$1.from",
                "type": "string",
                "tags": [],
                "label": "from",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getDateISORange.$1.to",
                "type": "string",
                "tags": [],
                "label": "to",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/timerange",
        "id": "def-common.getDateRange",
        "type": "Function",
        "tags": [],
        "label": "getDateRange",
        "description": [],
        "signature": [
          "({ from, to }: { from: string; to: string; }) => { startDate: number; endDate: number; }"
        ],
        "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/timerange",
            "id": "def-common.getDateRange.$1",
            "type": "Object",
            "tags": [],
            "label": "{ from, to }",
            "description": [],
            "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getDateRange.$1.from",
                "type": "string",
                "tags": [],
                "label": "from",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getDateRange.$1.to",
                "type": "string",
                "tags": [],
                "label": "to",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/timerange",
        "id": "def-common.getOffsetFromNowInSeconds",
        "type": "Function",
        "tags": [],
        "label": "getOffsetFromNowInSeconds",
        "description": [],
        "signature": [
          "(epochDate: number) => number"
        ],
        "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/timerange",
            "id": "def-common.getOffsetFromNowInSeconds.$1",
            "type": "number",
            "tags": [],
            "label": "epochDate",
            "description": [],
            "signature": [
              "number"
            ],
            "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/timerange",
        "id": "def-common.getTimeDifferenceInSeconds",
        "type": "Function",
        "tags": [],
        "label": "getTimeDifferenceInSeconds",
        "description": [],
        "signature": [
          "({\n  startDate,\n  endDate,\n}: { startDate: number; endDate: number; }) => number"
        ],
        "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/timerange",
            "id": "def-common.getTimeDifferenceInSeconds.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  startDate,\n  endDate,\n}",
            "description": [],
            "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getTimeDifferenceInSeconds.$1.startDate",
                "type": "number",
                "tags": [],
                "label": "startDate",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/timerange",
                "id": "def-common.getTimeDifferenceInSeconds.$1.endDate",
                "type": "number",
                "tags": [],
                "label": "endDate",
                "description": [],
                "path": "src/platform/packages/shared/kbn-timerange/src/index.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}