{ "id": "@kbn/server-route-repository", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.createServerRouteFactory", "type": "Function", "tags": [], "label": "createServerRouteFactory", "description": [], "signature": [ "() => > | undefined = undefined>(route: ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, ") => ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, "" ], "path": "packages/kbn-server-route-repository/src/create_server_route_factory.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.createServerRouteRepository", "type": "Function", "tags": [], "label": "createServerRouteRepository", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, "" ], "path": "packages/kbn-server-route-repository/src/create_server_route_repository.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.decodeRequestParams", "type": "Function", "tags": [], "label": "decodeRequestParams", "description": [], "signature": [ "(params: KibanaRequestParams, paramsRt: T) => ", "OutputOf", "" ], "path": "packages/kbn-server-route-repository/src/decode_request_params.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.decodeRequestParams.$1", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ "KibanaRequestParams" ], "path": "packages/kbn-server-route-repository/src/decode_request_params.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.decodeRequestParams.$2", "type": "Uncategorized", "tags": [], "label": "paramsRt", "description": [], "signature": [ "T" ], "path": "packages/kbn-server-route-repository/src/decode_request_params.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.formatRequest", "type": "Function", "tags": [], "label": "formatRequest", "description": [], "signature": [ "(endpoint: string, pathParams: Record) => { method: Method; pathname: string; }" ], "path": "packages/kbn-server-route-repository/src/format_request.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.formatRequest.$1", "type": "string", "tags": [], "label": "endpoint", "description": [], "signature": [ "string" ], "path": "packages/kbn-server-route-repository/src/format_request.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.formatRequest.$2", "type": "Object", "tags": [], "label": "pathParams", "description": [], "signature": [ "Record" ], "path": "packages/kbn-server-route-repository/src/format_request.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.parseEndpoint", "type": "Function", "tags": [], "label": "parseEndpoint", "description": [], "signature": [ "(endpoint: string) => { method: Method; pathname: string; }" ], "path": "packages/kbn-server-route-repository/src/parse_endpoint.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.parseEndpoint.$1", "type": "string", "tags": [], "label": "endpoint", "description": [], "signature": [ "string" ], "path": "packages/kbn-server-route-repository/src/parse_endpoint.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository", "type": "Interface", "tags": [], "label": "ServerRouteRepository", "description": [], "signature": [ { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, "" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository.add", "type": "Function", "tags": [], "label": "add", "description": [], "signature": [ "> | undefined = undefined>(route: ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, ") => ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, "; }>" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository.add.$1", "type": "CompoundType", "tags": [], "label": "route", "description": [], "signature": [ { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, "" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository.merge", "type": "Function", "tags": [], "label": "merge", "description": [], "signature": [ ">(repository: TServerRouteRepository) => TServerRouteRepository extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " ? ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository.merge.$1", "type": "Uncategorized", "tags": [], "label": "repository", "description": [], "signature": [ "TServerRouteRepository" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRouteRepository.getRoutes", "type": "Function", "tags": [], "label": "getRoutes", "description": [], "signature": [ "() => ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, ">, TRouteHandlerResources, unknown, TRouteCreateOptions>[]" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "children": [], "returnComment": [] } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ClientRequestParamsOf", "type": "Type", "tags": [], "label": "ClientRequestParamsOf", "description": [], "signature": [ "TServerRouteRepository extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, "> ? TRouteParamsRT extends WithoutIncompatibleMethods<", "Type", "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? ClientRequestParamsOfType : {} : never : never : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.DecodedRequestParamsOf", "type": "Type", "tags": [], "label": "DecodedRequestParamsOf", "description": [], "signature": [ "TServerRouteRepository extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, "> ? TRouteParamsRT extends WithoutIncompatibleMethods<", "Type", "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? DecodedRequestParamsOfType : {} : never : never : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.EndpointOf", "type": "Type", "tags": [], "label": "EndpointOf", "description": [], "signature": [ "TServerRouteRepository extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " ? keyof TRouteState : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ReturnOf", "type": "Type", "tags": [], "label": "ReturnOf", "description": [], "signature": [ "TServerRouteRepository extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRouteRepository", "text": "ServerRouteRepository" }, " ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ServerRoute", "text": "ServerRoute" }, "> ? TReturnType : never : never : never" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.RouteParamsRT", "type": "Type", "tags": [], "label": "RouteParamsRT", "description": [], "signature": [ "Pick<", "Type", "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>, \"pipe\" | \"name\" | \"is\" | \"_A\" | \"_O\" | \"validate\" | \"_I\" | \"asDecoder\" | \"decode\"> & { encode: ", "Encode", "; asEncoder: () => ", "Encoder", "; }" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.RouteRepositoryClient", "type": "Type", "tags": [], "label": "RouteRepositoryClient", "description": [], "signature": [ ">(options: { endpoint: TEndpoint; } & ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions) => Promise<", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ReturnOf", "text": "ReturnOf" }, ">" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.RouteRepositoryClient.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ "{ endpoint: TEndpoint; } & ", { "pluginId": "@kbn/server-route-repository", "scope": "server", "docId": "kibKbnServerRouteRepositoryPluginApi", "section": "def-server.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.ServerRoute", "type": "Type", "tags": [], "label": "ServerRoute", "description": [], "signature": [ "{ endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends WithoutIncompatibleMethods<", "Type", "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? DecodedRequestParamsOfType : {})) => Promise; } & TRouteCreateOptions" ], "path": "packages/kbn-server-route-repository/src/typings.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.routeValidationObject", "type": "Object", "tags": [], "label": "routeValidationObject", "description": [], "path": "packages/kbn-server-route-repository/src/route_validation_object.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.routeValidationObject.body", "type": "Object", "tags": [], "label": "body", "description": [ "// `body` can be null, but `validate` expects non-nullable types\n// if any validation is defined. Not having validation currently\n// means we don't get the payload. See\n// https://github.com/elastic/kibana/issues/50179" ], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "server", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-server.Type", "text": "Type" }, " | null>" ], "path": "packages/kbn-server-route-repository/src/route_validation_object.ts", "deprecated": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.routeValidationObject.params", "type": "Object", "tags": [], "label": "params", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "server", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-server.ObjectType", "text": "ObjectType" }, "<{}>" ], "path": "packages/kbn-server-route-repository/src/route_validation_object.ts", "deprecated": false }, { "parentPluginId": "@kbn/server-route-repository", "id": "def-server.routeValidationObject.query", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ { "pluginId": "@kbn/config-schema", "scope": "server", "docId": "kibKbnConfigSchemaPluginApi", "section": "def-server.ObjectType", "text": "ObjectType" }, "<{}>" ], "path": "packages/kbn-server-route-repository/src/route_validation_object.ts", "deprecated": false } ], "initialIsOpen": false } ] }, "common": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] } }