kibana/api_docs/kbn_apm_utils.json
Stacey Gammon e92a945ab1
Add packages to our API documentation (#113564) (#114513)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
# Conflicts:
#	api_docs/alerting.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/custom_integrations.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/event_log.mdx
#	api_docs/fleet.mdx
#	api_docs/home.json
#	api_docs/index_management.json
#	api_docs/interactive_setup.mdx
#	api_docs/kibana_legacy.json
#	api_docs/kibana_legacy.mdx
#	api_docs/observability.mdx
#	api_docs/plugin_directory.mdx
#	api_docs/security_oss.mdx
2021-10-11 13:58:18 -04:00

221 lines
6.2 KiB
JSON

{
"id": "@kbn/apm-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.parseSpanOptions",
"type": "Function",
"tags": [],
"label": "parseSpanOptions",
"description": [],
"signature": [
"(optionsOrName: string | ",
{
"pluginId": "@kbn/apm-utils",
"scope": "server",
"docId": "kibKbnApmUtilsPluginApi",
"section": "def-server.SpanOptions",
"text": "SpanOptions"
},
") => ",
{
"pluginId": "@kbn/apm-utils",
"scope": "server",
"docId": "kibKbnApmUtilsPluginApi",
"section": "def-server.SpanOptions",
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.parseSpanOptions.$1",
"type": "CompoundType",
"tags": [],
"label": "optionsOrName",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/apm-utils",
"scope": "server",
"docId": "kibKbnApmUtilsPluginApi",
"section": "def-server.SpanOptions",
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.withSpan",
"type": "Function",
"tags": [],
"label": "withSpan",
"description": [],
"signature": [
"(optionsOrName: string | ",
{
"pluginId": "@kbn/apm-utils",
"scope": "server",
"docId": "kibKbnApmUtilsPluginApi",
"section": "def-server.SpanOptions",
"text": "SpanOptions"
},
", cb: (span?: ",
"Span",
" | undefined) => Promise<T>) => Promise<T>"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.withSpan.$1",
"type": "CompoundType",
"tags": [],
"label": "optionsOrName",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/apm-utils",
"scope": "server",
"docId": "kibKbnApmUtilsPluginApi",
"section": "def-server.SpanOptions",
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.withSpan.$2",
"type": "Function",
"tags": [],
"label": "cb",
"description": [],
"signature": [
"(span?: ",
"Span",
" | undefined) => Promise<T>"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions",
"type": "Interface",
"tags": [],
"label": "SpanOptions",
"description": [],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions.subtype",
"type": "string",
"tags": [],
"label": "subtype",
"description": [],
"signature": [
"string | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions.labels",
"type": "Object",
"tags": [],
"label": "labels",
"description": [],
"signature": [
"Record<string, string> | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/apm-utils",
"id": "def-server.SpanOptions.intercept",
"type": "CompoundType",
"tags": [],
"label": "intercept",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}