Class RecordMapper

The RecordMapper class provides utility functions for mapping and transforming record types.

Since

v1.1.0

Index

Methods

Methods

`Static`omit

omit<K extends PropertyKey>(
keys: Iterable<K>,
): <T extends Partial<Record<K, unknown>>>(value: T) => Omit<T, K>
Omit function to omit keys from an object or use as map function to omit keys from an array
Type Parameters
- K extends PropertyKey
  Omit keys
Parameters
- keys: Iterable<K>
  to omit
Returns <T extends Partial<Record<K, unknown>>>(value: T) => Omit<T, K>
omitted object or map function
Example
```
type Data = {demo: string, value: number|null};
const dataArray: Data[] = [{demo: 'hello', value: null}];
const output: Omit<Data, 'demo'>[] = dataArray.map(RecordMapper.omit(['demo']));
```
Since
v1.1.0
- Defined in src/lib/RecordMapper.mts:38

`Static`pick

pick<K extends PropertyKey>(
keys: Iterable<K>,
): <T extends Partial<Record<K, unknown>>>(value: T) => Pick<T, K>
Pick function to pick keys from an object or use as map function to pick keys from an array
Type Parameters
- K extends PropertyKey
  Pick keys
Parameters
- keys: Iterable<K>
  keys to pick
Returns <T extends Partial<Record<K, unknown>>>(value: T) => Pick<T, K>
picked object or map function
Example
```
type Data = {demo: string, value: number | null};
const dataArray: Data[] = [{demo: 'hello', value: null}];
const output: Pick<Data, 'demo'>[] = dataArray.map(RecordMapper.pick(['demo']));
```
Since
v1.1.0
- Defined in src/lib/RecordMapper.mts:20

`Static`prop

prop<
    T extends any[]
    | Record<PropertyKey, any>,
    K extends string | number | symbol,
>(
    key: K,
): (target: T) => T[K]
Creates a function that selects a specific property value from an object.

Useful for use with arrays map function when extracting a single property from each object.
Type Parameters
- T extends any[] | Record<PropertyKey, any>
  Object target from which the property will be selected
- K extends string | number | symbol
  Property name in target that will be selected
Parameters
- key: K
  The property name to select
Returns (target: T) => T[K]
select value by key from the target
Example
```
// property access
const ids = users.map(RecordMapper.prop('id'));
// index access
const getFirst = RecordMapper.prop(0);
const test = getFirst(['a', 'b', 'c']); // 'a'
```
Since
v1.1.0
- Defined in src/lib/RecordMapper.mts:60
prop<K extends PropertyKey>(
key: K,
): <T extends Record<K, any>>(target: T) => T[K]
Creates a function that selects a specific property value from an object.

Useful for use with arrays map function when extracting a single property from each object.
Type Parameters
- K extends PropertyKey
  Property name in target that will be selected
Parameters
- key: K
  The property name to select
Returns <T extends Record<K, any>>(target: T) => T[K]
select value by key from the target
Example
```
// property access
const ids = users.map(RecordMapper.prop('id'));
// index access
const getFirst = RecordMapper.prop(0);
const test = getFirst(['a', 'b', 'c']); // 'a'
```
Since
v1.1.0
- Defined in src/lib/RecordMapper.mts:61