mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 09:19:04 -04:00
691 lines
No EOL
22 KiB
JSON
691 lines
No EOL
22 KiB
JSON
{
|
|
"id": "@kbn/i18n",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslateArguments",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TranslateArguments",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslateArguments.defaultMessage",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "defaultMessage",
|
|
"description": [
|
|
"\nWill be used unless translation was successful"
|
|
],
|
|
"signature": [
|
|
"string | ",
|
|
"MessageFormatElement",
|
|
"[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslateArguments.description",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "description",
|
|
"description": [
|
|
"\nMessage description, used by translators and other devs to understand the message context."
|
|
],
|
|
"signature": [
|
|
"string | object | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslateArguments.values",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "values",
|
|
"description": [
|
|
"\nvalues to pass into translation"
|
|
],
|
|
"signature": [
|
|
"Record<string, ",
|
|
"PrimitiveType",
|
|
" | ",
|
|
"FormatXMLElementFn",
|
|
"<string, string>> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslateArguments.ignoreTag",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "ignoreTag",
|
|
"description": [
|
|
"\nWhether to treat HTML/XML tags as string literal\ninstead of parsing them as tag token.\nWhen this is false we only allow simple tags without\nany attributes"
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.Translation",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "Translation",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.Translation",
|
|
"text": "Translation"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.Translation.defaultLocale",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultLocale",
|
|
"description": [
|
|
"\nDefault locale to fall back to when the translation is not found for the message id.\nHardcoded to `en` for Kibana."
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.Translation.defaultFormats",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "defaultFormats",
|
|
"description": [
|
|
"\ndefault formatter formats."
|
|
],
|
|
"signature": [
|
|
"CustomFormats"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslationInput",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "TranslationInput",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslationInput.messages",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "messages",
|
|
"description": [
|
|
"\nActual translated messages."
|
|
],
|
|
"signature": [
|
|
"Record<string, string> | Record<string, ",
|
|
"MessageFormatElement",
|
|
"[]>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslationInput.locale",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "locale",
|
|
"description": [
|
|
"\nLocale of the translated messages."
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.TranslationInput.formats",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "formats",
|
|
"description": [
|
|
"\nSet of options to the underlying formatter."
|
|
],
|
|
"signature": [
|
|
"CustomFormats",
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/translation.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.Formats",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "Formats",
|
|
"description": [],
|
|
"signature": [
|
|
"CustomFormats"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/formats.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "i18n",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.getTranslation",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTranslation",
|
|
"description": [],
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.Translation",
|
|
"text": "Translation"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.getLocale",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getLocale",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.translate",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "translate",
|
|
"description": [],
|
|
"signature": [
|
|
"(id: string, { values, description, defaultMessage, ignoreTag }: ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslateArguments",
|
|
"text": "TranslateArguments"
|
|
},
|
|
") => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.translate.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "id",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.translate.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "__1",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslateArguments",
|
|
"text": "TranslateArguments"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.init",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "init",
|
|
"description": [],
|
|
"signature": [
|
|
"(newTranslation?: ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
},
|
|
" | undefined) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.init.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "newTranslation",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.load",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "load",
|
|
"description": [],
|
|
"signature": [
|
|
"(translationsUrl: string) => Promise<void>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.load.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "translationsUrl",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/core/i18n.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.handleIntlError",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "handleIntlError",
|
|
"description": [],
|
|
"signature": [
|
|
"(err: ",
|
|
"MissingTranslationError",
|
|
" | ",
|
|
"MessageFormatError",
|
|
" | ",
|
|
"MissingDataError",
|
|
" | ",
|
|
"InvalidConfigError",
|
|
" | ",
|
|
"UnsupportedFormatterError",
|
|
" | ",
|
|
"FormatError",
|
|
") => void"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.handleIntlError.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "err",
|
|
"description": [],
|
|
"signature": [
|
|
"MissingTranslationError",
|
|
" | ",
|
|
"MessageFormatError",
|
|
" | ",
|
|
"MissingDataError",
|
|
" | ",
|
|
"InvalidConfigError",
|
|
" | ",
|
|
"UnsupportedFormatterError",
|
|
" | ",
|
|
"FormatError"
|
|
],
|
|
"path": "node_modules/@formatjs/intl/src/types.d.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18n.getIsInitialized",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getIsInitialized",
|
|
"description": [],
|
|
"signature": [
|
|
"() => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "i18nLoader",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.registerTranslationFile",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerTranslationFile",
|
|
"description": [],
|
|
"signature": [
|
|
"(translationFilePath: string) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.registerTranslationFile.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "translationFilePath",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/loader.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.registerTranslationFiles",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerTranslationFiles",
|
|
"description": [],
|
|
"signature": [
|
|
"(arrayOfPaths?: string[]) => void"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.registerTranslationFiles.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "arrayOfPaths",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/loader.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getTranslationsByLocale",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getTranslationsByLocale",
|
|
"description": [],
|
|
"signature": [
|
|
"(locale: string) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
},
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getTranslationsByLocale.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "locale",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/loader.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getAllTranslations",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllTranslations",
|
|
"description": [],
|
|
"signature": [
|
|
"() => Promise<{ [key: string]: ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
},
|
|
"; }>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getAllTranslationsFromPaths",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getAllTranslationsFromPaths",
|
|
"description": [],
|
|
"signature": [
|
|
"(paths: string[]) => Promise<{ [key: string]: ",
|
|
{
|
|
"pluginId": "@kbn/i18n",
|
|
"scope": "common",
|
|
"docId": "kibKbnI18nPluginApi",
|
|
"section": "def-common.TranslationInput",
|
|
"text": "TranslationInput"
|
|
},
|
|
"; }>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getAllTranslationsFromPaths.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "paths",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/src/loader.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/i18n",
|
|
"id": "def-common.i18nLoader.getRegisteredLocales",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRegisteredLocales",
|
|
"description": [],
|
|
"signature": [
|
|
"() => string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-i18n/index.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |