Skip to content

Commit 72c4e23

Browse files
mshustovmshustov
committed
force savedObject API consumers to define SO type explicitly (#58022)
* force savedObject consumers to define type explicitly * address comments * regen docs
1 parent 369004b commit 72c4e23

95 files changed

Lines changed: 387 additions & 329 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/development/core/public/kibana-plugin-public.savedobject.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export interface SavedObject<T extends SavedObjectAttributes = any>
11+
export interface SavedObject<T = unknown>
1212
```
1313

1414
## Properties

‎docs/development/core/public/kibana-plugin-public.savedobjectsbatchresponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export interface SavedObjectsBatchResponse<T extends SavedObjectAttributes = SavedObjectAttributes>
11+
export interface SavedObjectsBatchResponse<T = unknown>
1212
```
1313

1414
## Properties

‎docs/development/core/public/kibana-plugin-public.savedobjectsbulkcreateobject.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<b>Signature:</b>
88

99
```typescript
10-
export interface SavedObjectsBulkCreateObject<T extends SavedObjectAttributes = SavedObjectAttributes> extends SavedObjectsCreateOptions
10+
export interface SavedObjectsBulkCreateObject<T = unknown> extends SavedObjectsCreateOptions
1111
```
1212
1313
## Properties

‎docs/development/core/public/kibana-plugin-public.savedobjectsbulkupdateobject.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export interface SavedObjectsBulkUpdateObject<T extends SavedObjectAttributes = SavedObjectAttributes>
11+
export interface SavedObjectsBulkUpdateObject<T = unknown>
1212
```
1313

1414
## Properties

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.bulkcreate.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Creates multiple documents at once
99
<b>Signature:</b>
1010

1111
```typescript
12-
bulkCreate: (objects?: SavedObjectsBulkCreateObject<SavedObjectAttributes>[], options?: SavedObjectsBulkCreateOptions) => Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
12+
bulkCreate: (objects?: SavedObjectsBulkCreateObject<unknown>[], options?: SavedObjectsBulkCreateOptions) => Promise<SavedObjectsBatchResponse<unknown>>;
1313
```

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.bulkget.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Returns an array of objects by id
1212
bulkGet: (objects?: {
1313
id: string;
1414
type: string;
15-
}[]) => Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
15+
}[]) => Promise<SavedObjectsBatchResponse<unknown>>;
1616
```
1717

1818
## Example

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.bulkupdate.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Update multiple documents at once
99
<b>Signature:</b>
1010

1111
```typescript
12-
bulkUpdate<T extends SavedObjectAttributes>(objects?: SavedObjectsBulkUpdateObject[]): Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>;
12+
bulkUpdate<T = unknown>(objects?: SavedObjectsBulkUpdateObject[]): Promise<SavedObjectsBatchResponse<unknown>>;
1313
```
1414

1515
## Parameters
@@ -20,7 +20,7 @@ bulkUpdate<T extends SavedObjectAttributes>(objects?: SavedObjectsBulkUpdateObje
2020

2121
<b>Returns:</b>
2222

23-
`Promise<SavedObjectsBatchResponse<SavedObjectAttributes>>`
23+
`Promise<SavedObjectsBatchResponse<unknown>>`
2424

2525
The result of the update operation containing both failed and updated saved objects.
2626

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.create.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Persists an object
99
<b>Signature:</b>
1010

1111
```typescript
12-
create: <T extends SavedObjectAttributes>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>>;
12+
create: <T = unknown>(type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise<SimpleSavedObject<T>>;
1313
```

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.find.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Search for objects
99
<b>Signature:</b>
1010

1111
```typescript
12-
find: <T extends SavedObjectAttributes>(options: Pick<SavedObjectFindOptionsServer, "search" | "filter" | "type" | "page" | "perPage" | "sortField" | "fields" | "searchFields" | "hasReference" | "defaultSearchOperator">) => Promise<SavedObjectsFindResponsePublic<T>>;
12+
find: <T = unknown>(options: Pick<SavedObjectFindOptionsServer, "search" | "filter" | "type" | "page" | "perPage" | "sortField" | "fields" | "searchFields" | "hasReference" | "defaultSearchOperator">) => Promise<SavedObjectsFindResponsePublic<T>>;
1313
```

‎docs/development/core/public/kibana-plugin-public.savedobjectsclient.get.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Fetches a single object
99
<b>Signature:</b>
1010

1111
```typescript
12-
get: <T extends SavedObjectAttributes>(type: string, id: string) => Promise<SimpleSavedObject<T>>;
12+
get: <T = unknown>(type: string, id: string) => Promise<SimpleSavedObject<T>>;
1313
```

0 commit comments

Comments
 (0)