Is there a way to inform TypeScript that an object can only return properties from values found within an array?

Question

Is there a way to inform TypeScript that an object can only return properties from values found within an array?

I am trying to ensure that the return object from a function in TypeScript only allows keys that correspond to string values present in an array passed as an argument to the function. The returned object should contain a subset of keys from a list of valid strings based on the input array. I am struggling with referencing the actual values provided to 'myArr'.

declare type ListOfStrings = 'apple' | 'banana' | 'car';
function doSomething(myArr: ListOfStrings[]) {
    const returnObj: { [Properties in ListOfStrings]?: number } = {}; 
    for (const entry of myArr) returnObj[entry] = Math.random();
    return returnObj;
}

const finalObj = doSomething(['banana', 'car']);
console.log(finalObj.apple); // This does not generate a TypeScript error, which is what I want help with.

Any advice would be greatly appreciated!

typescript

Answer 1

Answer №1

If you want to ensure the correct structure of your object, consider making your function generic

function createObject<T extends ArrayOfStrings>(myArr:T[] ) {
    const resultObj: { [Property in T]?: number } = {}; 
    for (const item of myArr) resultObj[item] = Math.random();
    return resultObj;
}

This approach will guarantee that the resulting object follows the desired format

const newObj = createObject(['apple', 'truck']);
const newObj: {
   apple?: number | undefined;
   truck?: number | undefined;
}

Answer 2

If you want to ensure the correct structure of your object, consider making your function generic

function createObject<T extends ArrayOfStrings>(myArr:T[] ) {
    const resultObj: { [Property in T]?: number } = {}; 
    for (const item of myArr) resultObj[item] = Math.random();
    return resultObj;
}

This approach will guarantee that the resulting object follows the desired format

const newObj = createObject(['apple', 'truck']);
const newObj: {
   apple?: number | undefined;
   truck?: number | undefined;
}

Answer 3

Answer №2

Employ Generics in tandem with Mapped Types.

type ListOfFruits = 'apple' | 'banana' | 'car';

function processItems<
    T extends ListOfFruits,             // Ensure the items in `arr` are part of this union.
    K extends Extract<ListOfFruits, T>  // Extract only the values included in the `arr`.
>(arr: T[]){
    const result = {} as { [k in K]: number }; // Map union `K` to return value properties.

    for (const entry of arr){
        result[entry as K] = Math.random();    // Indicate to the compiler that the value of `arr` is one of K.
    }

    return result;
}

const valid = processItems(['banana', 'car']);  // valid
valid.banana; // valid
valid.orange; // error

const invalid = processItems(['banana', 'orange']);  // error

See Demo in playground.

Answer 4

Employ Generics in tandem with Mapped Types.

type ListOfFruits = 'apple' | 'banana' | 'car';

function processItems<
    T extends ListOfFruits,             // Ensure the items in `arr` are part of this union.
    K extends Extract<ListOfFruits, T>  // Extract only the values included in the `arr`.
>(arr: T[]){
    const result = {} as { [k in K]: number }; // Map union `K` to return value properties.

    for (const entry of arr){
        result[entry as K] = Math.random();    // Indicate to the compiler that the value of `arr` is one of K.
    }

    return result;
}

const valid = processItems(['banana', 'car']);  // valid
valid.banana; // valid
valid.orange; // error

const invalid = processItems(['banana', 'orange']);  // error

See Demo in playground.

Answer 5

Answer №3

Not flawless, but it should do the job

function performAction<Keys extends string>(keys: Keys[]): Partial<Record<Keys, number>> {
    const returnObject: Partial<Record<Keys, number>> = {};
    for (const item of keys) {
        returnObject[item] = Math.random();
    }
    return returnObject;
}

const result = performAction(['alpha', 'beta']);
result.c // error

TypeScript Playground Link

Answer 6

Not flawless, but it should do the job

function performAction<Keys extends string>(keys: Keys[]): Partial<Record<Keys, number>> {
    const returnObject: Partial<Record<Keys, number>> = {};
    for (const item of keys) {
        returnObject[item] = Math.random();
    }
    return returnObject;
}

const result = performAction(['alpha', 'beta']);
result.c // error

TypeScript Playground Link

Is there a way to inform TypeScript that an object can only return properties from values found within an array?

Answer №1

Answer №2

Answer №3

Similar questions

Implementing pagination within an Angular 11 Mat-table with grouping feature

Generating Tree Structure Object Automatically from Collection using Keys

Angular Appreciation Meter

Incorporating HTML code within a .ts file: a basic guide

There was an error during compilation: Module not detected - Unable to locate './xxxx'

Exploring methods to retrieve the status attribute of an Angular httpClient response

Exploring the capabilities of google-diff-match-patch within the Angular framework

Issue with exclude not functioning in tsconfig.json for Angular Typescript deployment

Creating a Typescript interface for a sophisticated response fetched from a REST API

Working with dual generic parameters in a function

Expressjs makes it easy to upload audio files to your website

Express throwing module errors

"Angular 2: Organize and refine data with sorting and

Vitest encountered an issue fetching a local file

tsc will automatically incorporate additional files

Ways to conceal a table and button in the absence of data for display

Integrating Constant Contact API into a Next.js application

I'm having trouble grasping the concept of 'globals' in TypeScript/NodeJS and distinguishing their differences. Can someone explain it to me?

The debugger extension for Visual Studio Code in Chrome, [webkit-debug-adapter], received a response from the target application, but was unable to find any valid target

Failed to decipher an ID token from firebase