Short summary
Given:
TupleType: a tuple of similar objectsKeyProperty: a key that is...- Present on every object in the tuple
- Used to hold
stringvalues
Provide:
A Record-like object that indexes the tuple entries using the specified key property instead of array indexes.
Potential definition
Type:
type RecordOf<
TupleType extends Array<object> | ReadonlyArray<object>,
KeyProperty extends keyof TupleType[number]
> = {
[Item in TupleType[number] as `${Item[KeyProperty]}`]: Item;
};Transformation function:
function toRecord<
TupleType extends Array<object> | ReadonlyArray<object>,
KeyProperty extends keyof TupleType[number]
>(
tuple: TupleType,
keyProperty: KeyProperty
): RecordOf<TupleType, KeyProperty> {
return Object.fromEntries(
tuple.map((item: TupleType[number]) => [String(item[keyProperty]), item])
) as RecordOf<TupleType, KeyProperty>;
}Example usage
const animalList = [
{ name: 'Shadow', species: 'dog', breed: 'Golden Retriever' },
{ name: 'Chance', species: 'dog', breed: 'Bulldog' },
{ name: 'Sassy', species: 'cat', breed: 'Siamese' },
{ name: 'Jake the Dog', species: 'dog', breed: 'Bulldog', isMagical: true },
] as const;
const animals = toRecord(animalList, 'name');
console.log(animals.Shadow);
console.log(animals['Jake the Dog'].isMagical);Other potential variations
- Provide transformation options (like camel casing the keys or adding a prefix)
sindresorhus / type-fest
A collection of essential TypeScript types
14.2k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too