kibana/api_docs/kbn_import_resolver.devdocs.json

828 lines
No EOL
28 KiB
JSON

{
"id": "@kbn/import-resolver",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver",
"type": "Class",
"tags": [],
"label": "ImportResolver",
"description": [],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"(repoRoot: string, packages?: ",
"Package",
"[]) => ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.ImportResolver",
"text": "ImportResolver"
}
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.create.$1",
"type": "string",
"tags": [],
"label": "repoRoot",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.create.$2",
"type": "Array",
"tags": [],
"label": "packages",
"description": [],
"signature": [
"Package",
"[]"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.Unnamed.$1",
"type": "string",
"tags": [],
"label": "cwd",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.Unnamed.$2",
"type": "Object",
"tags": [],
"label": "pkgsById",
"description": [],
"signature": [
"Map<string, ",
"Package",
">"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPackageIdForPath",
"type": "Function",
"tags": [],
"label": "getPackageIdForPath",
"description": [],
"signature": [
"(path: string) => string | null"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPackageIdForPath.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPackageManifestForPath",
"type": "Function",
"tags": [],
"label": "getPackageManifestForPath",
"description": [],
"signature": [
"(path: string) => ",
"KibanaPackageManifest",
" | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPackageManifestForPath.$1",
"type": "string",
"tags": [],
"label": "path",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getAbsolutePackageDir",
"type": "Function",
"tags": [],
"label": "getAbsolutePackageDir",
"description": [],
"signature": [
"(pkgId: string) => string | null"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getAbsolutePackageDir.$1",
"type": "string",
"tags": [],
"label": "pkgId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.isRepoPkg",
"type": "Function",
"tags": [],
"label": "isRepoPkg",
"description": [],
"signature": [
"(pkgId: string) => boolean"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.isRepoPkg.$1",
"type": "string",
"tags": [],
"label": "pkgId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPkgManifest",
"type": "Function",
"tags": [],
"label": "getPkgManifest",
"description": [],
"signature": [
"(pkgId: string) => ",
"KibanaPackageManifest",
" | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.getPkgManifest.$1",
"type": "string",
"tags": [],
"label": "pkgId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.resolve",
"type": "Function",
"tags": [],
"label": "resolve",
"description": [
"\nResolve an import request from a file in the given dirname"
],
"signature": [
"(req: string, dirname: string) => ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.ResolveResult",
"text": "ResolveResult"
},
" | null"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.resolve.$1",
"type": "string",
"tags": [],
"label": "req",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportResolver.resolve.$2",
"type": "string",
"tags": [],
"label": "dirname",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/import_resolver.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.getPackageRelativeImportReq",
"type": "Function",
"tags": [],
"label": "getPackageRelativeImportReq",
"description": [],
"signature": [
"(options: PackageRelativeImportReqOptions) => string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.getPackageRelativeImportReq.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"PackageRelativeImportReqOptions"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.getRelativeImportReq",
"type": "Function",
"tags": [],
"label": "getRelativeImportReq",
"description": [],
"signature": [
"(options: RelativeImportReqOptions) => string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.getRelativeImportReq.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"RelativeImportReqOptions"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.reduceImportRequest",
"type": "Function",
"tags": [],
"label": "reduceImportRequest",
"description": [],
"signature": [
"(req: string, type: ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.ImportType",
"text": "ImportType"
},
", original: string | undefined, sourceExt: string | undefined) => string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.reduceImportRequest.$1",
"type": "string",
"tags": [],
"label": "req",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.reduceImportRequest.$2",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.ImportType",
"text": "ImportType"
}
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.reduceImportRequest.$3",
"type": "string",
"tags": [],
"label": "original",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.reduceImportRequest.$4",
"type": "string",
"tags": [],
"label": "sourceExt",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.BuiltInResult",
"type": "Interface",
"tags": [],
"label": "BuiltInResult",
"description": [
"\nResolution result indicating that the import request resolves to a built-in node library"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.BuiltInResult.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"built-in\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult",
"type": "Interface",
"tags": [],
"label": "FileResult",
"description": [
"\nResolution result indicating that the import resolves to a specific file, possible in a nodeModule, with\nthe path of that file and the name of the nodeModule if applicable"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"file\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.absolute",
"type": "string",
"tags": [],
"label": "absolute",
"description": [],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.pkgId",
"type": "string",
"tags": [],
"label": "pkgId",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.nodeModule",
"type": "string",
"tags": [],
"label": "nodeModule",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.prefix",
"type": "string",
"tags": [],
"label": "prefix",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.FileResult.postfix",
"type": "string",
"tags": [],
"label": "postfix",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.IgnoreResult",
"type": "Interface",
"tags": [],
"label": "IgnoreResult",
"description": [
"\nResolution result indicating that the import request can't be resolved, but it shouldn't need to be\nbecause the file that is imported can't be resolved from the source alone, usually because it is explicitly\nimporting a build asset. Import requests which meet this criteria are manually added to the resolver and\ncan be trusted to exist after the build it complete or in their used location."
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.IgnoreResult.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ignore\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.OptionalDepResult",
"type": "Interface",
"tags": [],
"label": "OptionalDepResult",
"description": [
"\nResolution result indicating that the import request resolves to an npm dep which isn't\ncurrently installed so assumed to be optional"
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.OptionalDepResult.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"optional-and-missing\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.TypesResult",
"type": "Interface",
"tags": [],
"label": "TypesResult",
"description": [
"\nResolution result indicating that the import only resolves to an @types package, including the name of\nthe @types package. We don't validate the sub-path of these import strings and assume that TS will validate\nthem, we just need to know that they don't map to actual files on the filesystem or modules which will\nend up in the build or running code."
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.TypesResult.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"@types\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.TypesResult.module",
"type": "string",
"tags": [],
"label": "module",
"description": [],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ImportType",
"type": "Type",
"tags": [],
"label": "ImportType",
"description": [],
"signature": [
"\"esm\" | \"require\" | \"require-resolve\" | \"jest\""
],
"path": "src/platform/packages/private/kbn-import-resolver/src/helpers/import_req.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/import-resolver",
"id": "def-common.ResolveResult",
"type": "Type",
"tags": [],
"label": "ResolveResult",
"description": [
"\nPossible resolve result types"
],
"signature": [
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.BuiltInResult",
"text": "BuiltInResult"
},
" | ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.IgnoreResult",
"text": "IgnoreResult"
},
" | ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.TypesResult",
"text": "TypesResult"
},
" | ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.FileResult",
"text": "FileResult"
},
" | ",
{
"pluginId": "@kbn/import-resolver",
"scope": "common",
"docId": "kibKbnImportResolverPluginApi",
"section": "def-common.OptionalDepResult",
"text": "OptionalDepResult"
}
],
"path": "src/platform/packages/private/kbn-import-resolver/src/resolve_result.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}