You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development/core/public/kibana-plugin-core-public.md
-12Lines changed: 0 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,16 +27,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
27
27
|[AppNavLinkStatus](./kibana-plugin-core-public.appnavlinkstatus.md)| Status of the application's navLink. |
28
28
|[AppStatus](./kibana-plugin-core-public.appstatus.md)| Accessibility status of an application. |
29
29
30
-
## Functions
31
-
32
-
| Function | Description |
33
-
| --- | --- |
34
-
|[assertNever(x)](./kibana-plugin-core-public.assertnever.md)| Can be used in switch statements to ensure we perform exhaustive checks, see https://www.typescriptlang.org/docs/handbook/advanced-types.html\#exhaustiveness-checking|
35
-
|[deepFreeze(object)](./kibana-plugin-core-public.deepfreeze.md)| Apply Object.freeze to a value recursively and convert the return type to Readonly variant recursively |
36
-
|[getFlattenedObject(rootValue)](./kibana-plugin-core-public.getflattenedobject.md)| Flattens a deeply nested object to a map of dot-separated paths pointing to all primitive values \*\*and arrays\*\* from <code>rootValue</code>.<!---->example: getFlattenedObject(<!---->{ a: { b: 1, c: \[2,3\] } }<!---->) // =<!---->> { 'a.b': 1, 'a.c': \[2,3\] } |
37
-
|[isRelativeUrl(candidatePath)](./kibana-plugin-core-public.isrelativeurl.md)| Determine if a url is relative. Any url including a protocol, hostname, or port is not considered relative. This means that absolute \*paths\* are considered to be relative \*urls\*|
38
-
|[modifyUrl(url, urlModifier)](./kibana-plugin-core-public.modifyurl.md)| Takes a URL and a function that takes the meaningful parts of the URL as a key-value object, modifies some or all of the parts, and returns the modified parts formatted again as a url.<!---->Url Parts sent: - protocol - slashes (does the url have the //) - auth - hostname (just the name of the host, no port or auth information) - port - pathname (the path after the hostname, no query or hash, starts with a slash if there was a path) - query (always an object, even when no query on original url) - hash<!---->Why? - The default url library in node produces several conflicting properties on the "parsed" output. Modifying any of these might lead to the modifications being ignored (depending on which property was modified) - It's not always clear whether to use path/pathname, host/hostname, so this tries to add helpful constraints |
39
-
40
30
## Interfaces
41
31
42
32
| Interface | Description |
@@ -128,7 +118,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
128
118
|[ToastOptions](./kibana-plugin-core-public.toastoptions.md)| Options available for [IToasts](./kibana-plugin-core-public.itoasts.md) APIs. |
129
119
|[UiSettingsParams](./kibana-plugin-core-public.uisettingsparams.md)| UiSettings parameters defined by the plugins. |
|[URLMeaningfulParts](./kibana-plugin-core-public.urlmeaningfulparts.md)| We define our own typings because the current version of @<!---->types/node declares properties to be optional "hostname?: string". Although, parse call returns "hostname: null \| string". |
132
121
|[UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md)| Describes the values explicitly set by user. |
133
122
134
123
## Variables
@@ -156,7 +145,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
|[FatalErrorsStart](./kibana-plugin-core-public.fatalerrorsstart.md)| FatalErrors stop the Kibana Public Core and displays a fatal error screen with details about the Kibana build and the error. |
|[HandlerContextType](./kibana-plugin-core-public.handlercontexttype.md)| Extracts the type of the first argument of a [HandlerFunction](./kibana-plugin-core-public.handlerfunction.md) to represent the type of the context. |
161
149
|[HandlerFunction](./kibana-plugin-core-public.handlerfunction.md)| A function that accepts a context object and an optional number of additional arguments. Used for the generic types in [IContextContainer](./kibana-plugin-core-public.icontextcontainer.md)|
162
150
|[HandlerParameters](./kibana-plugin-core-public.handlerparameters.md)| Extracts the types of the additional arguments of a [HandlerFunction](./kibana-plugin-core-public.handlerfunction.md)<!---->, excluding the [HandlerContextType](./kibana-plugin-core-public.handlercontexttype.md)<!---->. |
0 commit comments