{ "id": "@kbn/handlebars", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [], "interfaces": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperDelegateFixed", "type": "Interface", "tags": [], "label": "HelperDelegateFixed", "description": [ "\nA {@link https://handlebarsjs.com/api-reference/helpers.html helper-function} type.\n\nWhen registering a helper function, it should be of this type." ], "signature": [ "HelperDelegate" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperDelegateFixed.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions", "type": "Interface", "tags": [], "label": "HelperOptions", "description": [ "\nThe last argument being passed to a helper function is a an {@link https://handlebarsjs.com/api-reference/helpers.html#the-options-parameter options object}." ], "signature": [ { "pluginId": "@kbn/handlebars", "scope": "common", "docId": "kibKbnHandlebarsPluginApi", "section": "def-common.HelperOptions", "text": "HelperOptions" }, " extends Omit<", "HelperOptions", ", \"fn\" | \"inverse\">" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.name", "type": "string", "tags": [], "label": "name", "description": [], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.fn", "type": "Function", "tags": [], "label": "fn", "description": [], "signature": [ "TemplateDelegate", "" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.fn.$1", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "T | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.fn.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/handlebars", "scope": "common", "docId": "kibKbnHandlebarsPluginApi", "section": "def-common.RuntimeOptions", "text": "RuntimeOptions" }, " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.inverse", "type": "Function", "tags": [], "label": "inverse", "description": [], "signature": [ "TemplateDelegate", "" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.inverse.$1", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "T | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.inverse.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/handlebars", "scope": "common", "docId": "kibKbnHandlebarsPluginApi", "section": "def-common.RuntimeOptions", "text": "RuntimeOptions" }, " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.loc", "type": "Object", "tags": [], "label": "loc", "description": [], "signature": [ "{ start: hbs.AST.Position; end: hbs.AST.Position; }" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.lookupProperty", "type": "Function", "tags": [], "label": "lookupProperty", "description": [], "signature": [ "(parent: Record, propertyName: string) => T" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.lookupProperty.$1", "type": "Object", "tags": [], "label": "parent", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.HelperOptions.lookupProperty.$2", "type": "string", "tags": [], "label": "propertyName", "description": [], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.RuntimeOptions", "type": "Interface", "tags": [], "label": "RuntimeOptions", "description": [ "\nSupported Handlebars runtime options\n\nThis is a subset of all the runtime options supported by the upstream\nHandlebars module." ], "signature": [ { "pluginId": "@kbn/handlebars", "scope": "common", "docId": "kibKbnHandlebarsPluginApi", "section": "def-common.RuntimeOptions", "text": "RuntimeOptions" }, " extends Pick<", "RuntimeOptions", ", \"data\" | \"blockParams\">" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.RuntimeOptions.helpers", "type": "Object", "tags": [], "label": "helpers", "description": [], "signature": [ "HelpersHash", " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.RuntimeOptions.partials", "type": "Object", "tags": [], "label": "partials", "description": [], "signature": [ "PartialsHash", " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.RuntimeOptions.decorators", "type": "Object", "tags": [], "label": "decorators", "description": [], "signature": [ "DecoratorsHash", " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.TemplateDelegateFixed", "type": "Interface", "tags": [], "label": "TemplateDelegateFixed", "description": [ "\nA template-function type.\n\nThis type is primarily used for the return value of by calls to\n{@link https://handlebarsjs.com/api-reference/compilation.html#handlebars-compile-template-options Handlebars.compile},\nHandlebars.compileAST and {@link https://handlebarsjs.com/api-reference/compilation.html#handlebars-precompile-template-options Handlebars.template}." ], "signature": [ "TemplateDelegate", "" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.TemplateDelegateFixed.Unnamed", "type": "Any", "tags": [], "label": "Unnamed", "description": [], "signature": [ "any" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.TemplateDelegateFixed.blockParams", "type": "number", "tags": [], "label": "blockParams", "description": [], "signature": [ "number | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.TemplateDelegateFixed.partials", "type": "Object", "tags": [], "label": "partials", "description": [], "signature": [ "PartialsHash", " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.compileFnName", "type": "CompoundType", "tags": [], "label": "compileFnName", "description": [ "\nIf the `unsafe-eval` CSP is set, this string constant will be `compile`,\notherwise `compileAST`.\n\nThis can be used to call the more optimized `compile` function in\nenvironments that support it, or fall back to `compileAST` on environments\nthat don't." ], "signature": [ "\"compile\" | \"compileAST\"" ], "path": "packages/kbn-handlebars/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.CompileOptions", "type": "Type", "tags": [], "label": "CompileOptions", "description": [ "\nSupported Handlebars compile options.\n\nThis is a subset of all the compile options supported by the upstream\nHandlebars module." ], "signature": [ "{ strict?: boolean | undefined; data?: boolean | undefined; knownHelpers?: KnownHelpers | undefined; knownHelpersOnly?: boolean | undefined; noEscape?: boolean | undefined; assumeObjects?: boolean | undefined; preventIndent?: boolean | undefined; explicitPartialContext?: boolean | undefined; }" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate", "type": "Type", "tags": [], "label": "DecoratorDelegate", "description": [ "\nA {@link https://github.com/handlebars-lang/handlebars.js/blob/master/docs/decorators-api.md decorator-function} type.\n\nWhen registering a decorator function, it should be of this type." ], "signature": [ "(prog: ", "TemplateDelegate", ", props: Record, container: ", "Container", ", options: any) => any" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$1", "type": "Function", "tags": [], "label": "prog", "description": [], "signature": [ "TemplateDelegate", "" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$1.$1", "type": "Uncategorized", "tags": [], "label": "context", "description": [], "signature": [ "T | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$1.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/handlebars", "scope": "common", "docId": "kibKbnHandlebarsPluginApi", "section": "def-common.RuntimeOptions", "text": "RuntimeOptions" }, " | undefined" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$2", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ "{ [x: string]: any; }" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$3", "type": "Object", "tags": [], "label": "container", "description": [], "signature": [ "Container" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.DecoratorDelegate.$4", "type": "Any", "tags": [], "label": "options", "description": [], "signature": [ "any" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "objects": [ { "parentPluginId": "@kbn/handlebars", "id": "def-common.handlebars", "type": "Object", "tags": [], "label": "'handlebars'", "description": [ "\nA custom version of the Handlebars module with an extra `compileAST` function and fixed typings." ], "signature": [ "typeof ", "node_modules/handlebars/types/index.d.ts" ], "path": "packages/kbn-handlebars/src/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/handlebars", "id": "def-common.Handlebars", "type": "Object", "tags": [], "label": "Handlebars", "description": [], "signature": [ "typeof ", "node_modules/handlebars/types/index.d.ts" ], "path": "node_modules/handlebars/types/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ] } }