Function includeKeys

includeKeys<
    O extends Record<PropertyKey, any>,
    K extends string | number | symbol,
>(
    object: O,
    keys: Iterable<K>,
): Pick<O, K>
Filter and include specific keys from an object (Based on https://github.com/sindresorhus/filter-obj)
Type Parameters
- O extends Record<PropertyKey, any>
  The object to filter and include keys from
- K extends string | number | symbol
  The key type
Parameters
- object: O
  The object to filter and include keys from
- keys: Iterable<K>
  The keys or keysCallback to include from the object
Returns Pick<O, K>
A new object with the included keys
Example
```
const object = {
  foo: true,
  bar: false
};
const newObject = includeKeys(object, (key, value, obj) => value === true); //=> {foo: true}
const newObject = includeKeys(object, ['bar']); //=> {bar: false}
```
Since
v0.2.8
- Defined in src/lib/objectUtils.mts:114
includeKeys<
    O extends Record<PropertyKey, any>,
    K extends string | number | symbol,
>(
    object: O,
    keyCallback: KeyCallback<O, K>,
): Partial<O>
Filter and include specific keys from an object (Based on https://github.com/sindresorhus/filter-obj)
Type Parameters
- O extends Record<PropertyKey, any>
  The object to filter and include keys from
- K extends string | number | symbol
  The key type
Parameters
- object: O
  The object to filter and include keys from
- keyCallback: KeyCallback<O, K>
Returns Partial<O>
A new object with the included keys
Example
```
const object = {
  foo: true,
  bar: false
};
const newObject = includeKeys(object, (key, value, obj) => value === true); //=> {foo: true}
const newObject = includeKeys(object, ['bar']); //=> {bar: false}
```
Since
v0.2.8
- Defined in src/lib/objectUtils.mts:115

Function includeKeys

Type Parameters

Parameters

Returns Pick<O, K>

Example

Since

Type Parameters

Parameters

Returns Partial<O>

Example

Since

Settings