kibana/api_docs/kbn_sort_predicates.devdocs.json

{
  "id": "@kbn/sort-predicates",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/sort-predicates",
        "id": "def-common.getSortingCriteria",
        "type": "Function",
        "tags": [],
        "label": "getSortingCriteria",
        "description": [],
        "signature": [
          "(type: string | undefined, sortBy: string, formatter: ",
          {
            "pluginId": "fieldFormats",
            "scope": "common",
            "docId": "kibFieldFormatsPluginApi",
            "section": "def-common.FieldFormat",
            "text": "FieldFormat"
          },
          ") => (rowA: Record<string, unknown> | null | undefined, rowB: Record<string, unknown> | null | undefined, direction: \"asc\" | \"desc\") => number"
        ],
        "path": "src/platform/packages/shared/kbn-sort-predicates/src/sorting.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/sort-predicates",
            "id": "def-common.getSortingCriteria.$1",
            "type": "string",
            "tags": [],
            "label": "type",
            "description": [],
            "signature": [
              "string | undefined"
            ],
            "path": "src/platform/packages/shared/kbn-sort-predicates/src/sorting.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": false
          },
          {
            "parentPluginId": "@kbn/sort-predicates",
            "id": "def-common.getSortingCriteria.$2",
            "type": "string",
            "tags": [],
            "label": "sortBy",
            "description": [],
            "signature": [
              "string"
            ],
            "path": "src/platform/packages/shared/kbn-sort-predicates/src/sorting.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/sort-predicates",
            "id": "def-common.getSortingCriteria.$3",
            "type": "Object",
            "tags": [],
            "label": "formatter",
            "description": [],
            "signature": [
              {
                "pluginId": "fieldFormats",
                "scope": "common",
                "docId": "kibFieldFormatsPluginApi",
                "section": "def-common.FieldFormat",
                "text": "FieldFormat"
              }
            ],
            "path": "src/platform/packages/shared/kbn-sort-predicates/src/sorting.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}