kibana/api_docs/kbn_server_route_repository_client.devdocs.json

{
  "id": "@kbn/server-route-repository-client",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.createRepositoryClient",
        "type": "Function",
        "tags": [],
        "label": "createRepositoryClient",
        "description": [],
        "signature": [
          "(core: ",
          "CoreStart",
          " | ",
          "CoreSetup",
          "<{}, unknown>) => ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteRepositoryClient",
            "text": "RouteRepositoryClient"
          },
          "<TRepository, TClientOptions>"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/create_repository_client.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.createRepositoryClient.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "core",
            "description": [],
            "signature": [
              "CoreStart",
              " | ",
              "CoreSetup",
              "<{}, unknown>"
            ],
            "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/create_repository_client.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.isHttpFetchError",
        "type": "Function",
        "tags": [],
        "label": "isHttpFetchError",
        "description": [],
        "signature": [
          "(error: unknown) => boolean"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/is_http_fetch_error.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.isHttpFetchError.$1",
            "type": "Unknown",
            "tags": [],
            "label": "error",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/is_http_fetch_error.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.isRequestAbortedError",
        "type": "Function",
        "tags": [],
        "label": "isRequestAbortedError",
        "description": [],
        "signature": [
          "(error: unknown) => boolean"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/is_request_aborted_error.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.isRequestAbortedError.$1",
            "type": "Unknown",
            "tags": [],
            "label": "error",
            "description": [],
            "signature": [
              "unknown"
            ],
            "path": "src/platform/packages/shared/kbn-server-route-repository-client/src/is_request_aborted_error.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.RouteRepositoryClient",
        "type": "Interface",
        "tags": [],
        "label": "RouteRepositoryClient",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteRepositoryClient",
            "text": "RouteRepositoryClient"
          },
          "<TServerRouteRepository, TAdditionalClientOptions>"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.RouteRepositoryClient.fetch",
            "type": "Function",
            "tags": [],
            "label": "fetch",
            "description": [],
            "signature": [
              "<TEndpoint extends Extract<keyof TServerRouteRepository, string>>(endpoint: TEndpoint, ...args: MaybeOptionalArgs<",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
              "HttpFetchOptions",
              ">) => Promise<",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ReturnOf",
                "text": "ReturnOf"
              },
              "<TServerRouteRepository, TEndpoint>>"
            ],
            "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/server-route-repository-client",
                "id": "def-public.RouteRepositoryClient.fetch.$1",
                "type": "Uncategorized",
                "tags": [],
                "label": "endpoint",
                "description": [],
                "signature": [
                  "TEndpoint"
                ],
                "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/server-route-repository-client",
                "id": "def-public.RouteRepositoryClient.fetch.$2",
                "type": "Uncategorized",
                "tags": [],
                "label": "args",
                "description": [],
                "signature": [
                  "MaybeOptionalArgs<",
                  {
                    "pluginId": "@kbn/server-route-repository-utils",
                    "scope": "common",
                    "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                    "section": "def-common.ClientRequestParamsOf",
                    "text": "ClientRequestParamsOf"
                  },
                  "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
                  "HttpFetchOptions",
                  ">"
                ],
                "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.RouteRepositoryClient.stream",
            "type": "Function",
            "tags": [],
            "label": "stream",
            "description": [],
            "signature": [
              "<TEndpoint extends Extract<keyof TServerRouteRepository, string>>(endpoint: TEndpoint, ...args: MaybeOptionalArgs<",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
              "HttpFetchOptions",
              ">) => ",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ReturnOf",
                "text": "ReturnOf"
              },
              "<TServerRouteRepository, TEndpoint> extends ",
              "Observable",
              "<infer TReturnType> ? TReturnType extends Record<string, unknown> & { type: string; } ? ",
              "Observable",
              "<TReturnType> : never : never"
            ],
            "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/server-route-repository-client",
                "id": "def-public.RouteRepositoryClient.stream.$1",
                "type": "Uncategorized",
                "tags": [],
                "label": "endpoint",
                "description": [],
                "signature": [
                  "TEndpoint"
                ],
                "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              },
              {
                "parentPluginId": "@kbn/server-route-repository-client",
                "id": "def-public.RouteRepositoryClient.stream.$2",
                "type": "Uncategorized",
                "tags": [],
                "label": "args",
                "description": [],
                "signature": [
                  "MaybeOptionalArgs<",
                  {
                    "pluginId": "@kbn/server-route-repository-utils",
                    "scope": "common",
                    "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                    "section": "def-common.ClientRequestParamsOf",
                    "text": "ClientRequestParamsOf"
                  },
                  "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
                  "HttpFetchOptions",
                  ">"
                ],
                "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
                "deprecated": false,
                "trackAdoption": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.ClientRequestParamsOf",
        "type": "Type",
        "tags": [],
        "label": "ClientRequestParamsOf",
        "description": [],
        "signature": [
          "TServerRouteRepository[TEndpoint] extends ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRoute",
            "text": "ServerRoute"
          },
          "<any, infer TRouteParamsRT extends ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteParamsRT",
            "text": "RouteParamsRT"
          },
          " | undefined, any, any, ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRouteCreateOptions",
            "text": "ServerRouteCreateOptions"
          },
          " | undefined> ? TRouteParamsRT extends ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteParamsRT",
            "text": "RouteParamsRT"
          },
          " ? ClientRequestParamsOfType<TRouteParamsRT> : TRouteParamsRT extends undefined ? {} : never : never"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.DefaultClientOptions",
        "type": "Type",
        "tags": [],
        "label": "DefaultClientOptions",
        "description": [],
        "signature": [
          "HttpFetchOptions"
        ],
        "path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}