Skip to content

Commit 8562812

Browse files
committed
Commit API changes
1 parent 4b08d1e commit 8562812

File tree

5 files changed

+31
-4
lines changed

5 files changed

+31
-4
lines changed

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.gettime.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
<b>Signature:</b>
88

99
```typescript
10-
export declare function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, forceNow?: Date): import("../..").RangeFilter | undefined;
10+
export declare function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, options?: {
11+
forceNow?: Date;
12+
fieldName?: string;
13+
}): import("../..").RangeFilter | undefined;
1114
```
1215

1316
## Parameters
@@ -16,7 +19,7 @@ export declare function getTime(indexPattern: IIndexPattern | undefined, timeRan
1619
| --- | --- | --- |
1720
| indexPattern | <code>IIndexPattern &#124; undefined</code> | |
1821
| timeRange | <code>TimeRange</code> | |
19-
| forceNow | <code>Date</code> | |
22+
| options | <code>{</code><br/><code> forceNow?: Date;</code><br/><code> fieldName?: string;</code><br/><code>}</code> | |
2023

2124
<b>Returns:</b>
2225

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IIndexPattern](./kibana-plugin-plugins-data-public.iindexpattern.md) &gt; [getTimeField](./kibana-plugin-plugins-data-public.iindexpattern.gettimefield.md)
4+
5+
## IIndexPattern.getTimeField() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
getTimeField?(): IFieldType | undefined;
11+
```
12+
<b>Returns:</b>
13+
14+
`IFieldType | undefined`
15+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iindexpattern.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ export interface IIndexPattern
2121
| [title](./kibana-plugin-plugins-data-public.iindexpattern.title.md) | <code>string</code> | |
2222
| [type](./kibana-plugin-plugins-data-public.iindexpattern.type.md) | <code>string</code> | |
2323

24+
## Methods
25+
26+
| Method | Description |
27+
| --- | --- |
28+
| [getTimeField()](./kibana-plugin-plugins-data-public.iindexpattern.gettimefield.md) | |
29+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
| [getEsPreference(uiSettings, sessionId)](./kibana-plugin-plugins-data-public.getespreference.md) | |
4444
| [getQueryLog(uiSettings, storage, appName, language)](./kibana-plugin-plugins-data-public.getquerylog.md) | |
4545
| [getSearchErrorType({ message })](./kibana-plugin-plugins-data-public.getsearcherrortype.md) | |
46-
| [getTime(indexPattern, timeRange, forceNow)](./kibana-plugin-plugins-data-public.gettime.md) | |
46+
| [getTime(indexPattern, timeRange, options)](./kibana-plugin-plugins-data-public.gettime.md) | |
4747
| [plugin(initializerContext)](./kibana-plugin-plugins-data-public.plugin.md) | |
4848

4949
## Interfaces

src/plugins/data/public/public.api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,10 @@ export function getSearchErrorType({ message }: Pick<SearchError, 'message'>): "
699699
// Warning: (ae-missing-release-tag) "getTime" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
700700
//
701701
// @public (undocumented)
702-
export function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, forceNow?: Date): import("../..").RangeFilter | undefined;
702+
export function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, options?: {
703+
forceNow?: Date;
704+
fieldName?: string;
705+
}): import("../..").RangeFilter | undefined;
703706

704707
// Warning: (ae-missing-release-tag) "IAggConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
705708
//

0 commit comments

Comments
 (0)