Welcome to Qi-U Community for programmer and developer-Open, Learning and Share
Welcome To Ask or Share your Answers For Others

Categories

0 votes
1.3k views
in Technique[技术] by (71.8m points)

Initialize empty object in typescript with Record type

How to define and initialize an object that can be empty.

With types

type Plan = 'plan1' | 'plan1';

interface IPlan {
    name: string
}

When I tried to initialize an empty object, I'm getting an error

const plans: Record<Plan, Readonly<IPlan> = {}; // **ERROR HERE**

plans.plan1 = {
    name: 'Plan #1'
}

Property 'plan1' is missing in type '{}' but required in type 'Record<"plan1", Readonly>'.

Playgro


与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
Welcome To Ask or Share your Answers For Others

Please log in or register to answer this question.

1 Answer

0 votes
by (71.8m points)

Simply use the Partial utility type: Partial<Type>

type Plan = 'plan1' | 'plan1';

interface IPlan {
    name: string
}


const plans: Partial<Record<Plan, IPlan>> = {}; // no error

plans.plan1 = {
    name: 'Plan #1'
}

The downside of this approach is that now all the properties of your interface are optional. But since you want it to instantiate without the required property, that is the only way.

Playground Link

Another idea might be using the Omit utility type: Omit<Type, Keys>

interface Plan {
  name: string;
}

type IPlan = Omit<Plan , "name">;

const plans: IPlan = {};

So, again, you can instantiate without the required properties.

Playground Link


与恶龙缠斗过久,自身亦成为恶龙;凝视深渊过久,深渊将回以凝视…
Welcome to Qi-U Community for programmer and developer-Open, Learning and Share
...