Can you defined a typedef and still use the spread operator to iterate using map()?

Question

I'm trying to define an Object using JSDoc typedefs. So given the following type definition:

/**
 * @typedef AccommodationData
 * @type {Object}
 * @property {string} id
 * @property {string} name
 * @property {boolean} selected
 */

I would define the type of accommodations. Then I want to be able to iterate over this using the map method and the spread operator to keep things concise.

import { LightningElement } from 'lwc';

export default class AccommodationList extends LightningElement {
    // --- Private properties ---

    /** @type {AccommodationData[]} */
    accommodations = [];

    // --- Getters ---
    
    /**
     * Get Accommodation Data with applied selections.
     * @returns {AccommodationData[]}
     */
    get accommodationsData() {
        return this.accommodations.map((a) => ({
            ...a,
            selected: this.selectedId === a.id
        }));
    }
}

When I do this, my IDE gives me the following warning:

Returned expression type (any & {selected: boolean})[] is not assignable to type AccommodationData[] Type any & {selected: boolean} is not assignable to type AccommodationData Type number is not assignable to type undefined

Is there a way to use this typedef with this method and not throw the warning from the IDE? (Error pictured below)

Could you provide code for class which use get accommodationsData because looks like this.accommodations has type any — maksimr
– maksimr, Commented Mar 4, 2023 at 20:16
@maksimr I updated the question with more of the class. I also added a screen grab of the warning/error I'm seeing. — Steve Schrab
– Steve Schrab, Commented Mar 6, 2023 at 15:45

Steve Schrab · Accepted Answer · 2023-08-31 16:53:58Z

0

The answer is to make these properties optional. Otherwise, they are required whenever defining a new instance of the Type.

    /**
     * @typedef AccommodationData
     * @type {Object}
     * @property {string} [id]
     * @property {string} [name]
     * @property {boolean} [selected]
     */

answered Aug 31, 2023 at 16:53

Steve Schrab

3976 silver badges17 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Can you defined a typedef and still use the spread operator to iterate using map()?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related