Skip to content

Commit

Permalink
update generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pgayvallet committed Nov 2, 2020
1 parent bbc9bbd commit fd1419c
Show file tree
Hide file tree
Showing 9 changed files with 88 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [CoreSetup](./kibana-plugin-core-server.coresetup.md) &gt; [i18n](./kibana-plugin-core-server.coresetup.i18n.md)

## CoreSetup.i18n property

[I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md)

<b>Signature:</b>

```typescript
i18n: I18nServiceSetup;
```
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
| [elasticsearch](./kibana-plugin-core-server.coresetup.elasticsearch.md) | <code>ElasticsearchServiceSetup</code> | [ElasticsearchServiceSetup](./kibana-plugin-core-server.elasticsearchservicesetup.md) |
| [getStartServices](./kibana-plugin-core-server.coresetup.getstartservices.md) | <code>StartServicesAccessor&lt;TPluginsStart, TStart&gt;</code> | [StartServicesAccessor](./kibana-plugin-core-server.startservicesaccessor.md) |
| [http](./kibana-plugin-core-server.coresetup.http.md) | <code>HttpServiceSetup &amp; {</code><br/><code> resources: HttpResources;</code><br/><code> }</code> | [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) |
| [i18n](./kibana-plugin-core-server.coresetup.i18n.md) | <code>I18nServiceSetup</code> | [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) |
| [logging](./kibana-plugin-core-server.coresetup.logging.md) | <code>LoggingServiceSetup</code> | [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) |
| [metrics](./kibana-plugin-core-server.coresetup.metrics.md) | <code>MetricsServiceSetup</code> | [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) |
| [savedObjects](./kibana-plugin-core-server.coresetup.savedobjects.md) | <code>SavedObjectsServiceSetup</code> | [SavedObjectsServiceSetup](./kibana-plugin-core-server.savedobjectsservicesetup.md) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) &gt; [getLocale](./kibana-plugin-core-server.i18nservicesetup.getlocale.md)

## I18nServiceSetup.getLocale() method

Return the locale currently in use.

<b>Signature:</b>

```typescript
getLocale(): string;
```
<b>Returns:</b>

`string`

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) &gt; [getTranslationFiles](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md)

## I18nServiceSetup.getTranslationFiles() method

Return the list of translation files currently in use.

<b>Signature:</b>

```typescript
getTranslationFiles(): string[];
```
<b>Returns:</b>

`string[]`

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md)

## I18nServiceSetup interface


<b>Signature:</b>

```typescript
export interface I18nServiceSetup
```

## Methods

| Method | Description |
| --- | --- |
| [getLocale()](./kibana-plugin-core-server.i18nservicesetup.getlocale.md) | Return the locale currently in use. |
| [getTranslationFiles()](./kibana-plugin-core-server.i18nservicesetup.gettranslationfiles.md) | Return the list of translation files currently in use. |

1 change: 1 addition & 0 deletions docs/development/core/server/kibana-plugin-core-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) | |
| [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to <code>hapi</code> server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. |
| [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) | |
| [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) | |
| [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
| [IContextContainer](./kibana-plugin-core-server.icontextcontainer.md) | An object that handles registration of context providers and configuring handlers with context. |
| [ICspConfig](./kibana-plugin-core-server.icspconfig.md) | CSP configuration for use in Kibana. |
Expand Down
10 changes: 10 additions & 0 deletions src/core/server/i18n/i18n_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,18 @@ interface SetupDeps {
pluginPaths: string[];
}

/**
* @public
*/
export interface I18nServiceSetup {
/**
* Return the locale currently in use.
*/
getLocale(): string;

/**
* Return the list of translation files currently in use.
*/
getTranslationFiles(): string[];
}

Expand Down
2 changes: 1 addition & 1 deletion src/core/server/plugins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export {
PluginsServiceStart,
UiPlugins,
} from './plugins_service';
export { config, PluginsConfig } from './plugins_config';
export { config } from './plugins_config';
/** @internal */
export { isNewPlatformPlugin } from './discovery';
export * from './types';
8 changes: 8 additions & 0 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
resources: HttpResources;
};
// (undocumented)
i18n: I18nServiceSetup;
// (undocumented)
logging: LoggingServiceSetup;
// (undocumented)
metrics: MetricsServiceSetup;
Expand Down Expand Up @@ -853,6 +855,12 @@ export interface HttpServiceStart {
getServerInfo: () => HttpServerInfo;
}

// @public (undocumented)
export interface I18nServiceSetup {
getLocale(): string;
getTranslationFiles(): string[];
}

// @public
export type IBasePath = Pick<BasePath, keyof BasePath>;

Expand Down

0 comments on commit fd1419c

Please sign in to comment.