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: ",
          {
            "pluginId": "@kbn/core-lifecycle-browser",
            "scope": "public",
            "docId": "kibKbnCoreLifecycleBrowserPluginApi",
            "section": "def-public.CoreStart",
            "text": "CoreStart"
          },
          " | ",
          {
            "pluginId": "@kbn/core-lifecycle-browser",
            "scope": "public",
            "docId": "kibKbnCoreLifecycleBrowserPluginApi",
            "section": "def-public.CoreSetup",
            "text": "CoreSetup"
          },
          "<object, unknown>) => { fetch: ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteRepositoryClient",
            "text": "RouteRepositoryClient"
          },
          "<TRepository, TClientOptions>; }"
        ],
        "path": "packages/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": [
              {
                "pluginId": "@kbn/core-lifecycle-browser",
                "scope": "public",
                "docId": "kibKbnCoreLifecycleBrowserPluginApi",
                "section": "def-public.CoreStart",
                "text": "CoreStart"
              },
              " | ",
              {
                "pluginId": "@kbn/core-lifecycle-browser",
                "scope": "public",
                "docId": "kibKbnCoreLifecycleBrowserPluginApi",
                "section": "def-public.CoreSetup",
                "text": "CoreSetup"
              },
              "<object, unknown>"
            ],
            "path": "packages/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": "packages/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": "packages/kbn-server-route-repository-client/src/is_http_fetch_error.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.ClientRequestParamsOf",
        "type": "Type",
        "tags": [],
        "label": "ClientRequestParamsOf",
        "description": [],
        "signature": [
          "TServerRouteRepository[TEndpoint] extends { endpoint: any; params?: infer TRouteParamsRT extends ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteParamsRT",
            "text": "RouteParamsRT"
          },
          " | undefined | undefined; handler: ({}: any) => Promise<any>; } & ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ServerRouteCreateOptions",
            "text": "ServerRouteCreateOptions"
          },
          " ? TRouteParamsRT extends ",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.RouteParamsRT",
            "text": "RouteParamsRT"
          },
          " ? ClientRequestParamsOfType<TRouteParamsRT> : {} : never"
        ],
        "path": "packages/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": [
          {
            "pluginId": "@kbn/core-http-browser",
            "scope": "public",
            "docId": "kibKbnCoreHttpBrowserPluginApi",
            "section": "def-public.HttpFetchOptions",
            "text": "HttpFetchOptions"
          }
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-client",
        "id": "def-public.RouteRepositoryClient",
        "type": "Type",
        "tags": [],
        "label": "RouteRepositoryClient",
        "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>) => Promise<",
          {
            "pluginId": "@kbn/server-route-repository-utils",
            "scope": "common",
            "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
            "section": "def-common.ReturnOf",
            "text": "ReturnOf"
          },
          "<TServerRouteRepository, TEndpoint>>"
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.RouteRepositoryClient.$1",
            "type": "Uncategorized",
            "tags": [],
            "label": "endpoint",
            "description": [],
            "signature": [
              "TEndpoint"
            ],
            "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/server-route-repository-client",
            "id": "def-public.RouteRepositoryClient.$2",
            "type": "Uncategorized",
            "tags": [],
            "label": "args",
            "description": [],
            "signature": [
              "RequiredKeys",
              "<",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions> extends never ? [] | [",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions] : [",
              {
                "pluginId": "@kbn/server-route-repository-utils",
                "scope": "common",
                "docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
                "section": "def-common.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions]"
            ],
            "path": "packages/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": []
  }
}