33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# `@kbn/utility-types`
|
|
|
|
TypeScript utility types for usage in Kibana.
|
|
|
|
- This package re-exports a subset of the items in [`utility-types`](https://github.com/piotrwitek/utility-types)
|
|
- You can also add more utility types here.
|
|
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { UnwrapPromise } from '@kbn/utility-types';
|
|
|
|
type A = Promise<string>;
|
|
type B = UnwrapPromise<A>; // string
|
|
```
|
|
|
|
|
|
## Reference
|
|
|
|
- `Assign<T, U>` — From `U` assign properties to `T` (just like object assign).
|
|
- `Ensure<T, X>` — Makes sure `T` is of type `X`.
|
|
- `ObservableLike<T>` — Minimal interface for an object resembling an `Observable`.
|
|
- `PublicContract<T>` — Returns an object with public keys only.
|
|
- `PublicKeys<T>` — Returns public keys of an object.
|
|
- `RecursiveReadonly<T>` — Like `Readonly<T>`, but freezes object recursively.
|
|
- `ShallowPromise<T>` — Same as `Promise` type, but it flat maps the wrapped type.
|
|
- `UnionToIntersection<T>` — Converts a union of types into an intersection.
|
|
- `UnwrapObservable<T>` — Returns wrapped type of an observable.
|
|
- `UnwrapPromise<T>` — Returns wrapped type of a promise.
|
|
- `UnwrapPromiseOrReturn<T>` — Returns wrapped type of a promise or the type itself, if it isn't a promise.
|
|
- `Values<T>` — Returns object or array value types.
|