Typescript object with [key: string]: string | string[]

Question

I have a type defined as follows:

type IColumn = {
  name: string;
  key: string;
  attributes: { [key: string]: string | string[] };
  shortable: boolean;
};

The only field of attributes that can be string[] is called options

So I would like to do something of the type:

type IColumn = {
  name: string;
  key: string;
  attributes: { [key: string]: string ; options: string[] };
  shortable: boolean;
};

To avoid having to specify at each use of attributes whether it is string or string[]. But this does not work.

Is there a way to make it?

Does this answer your question? How do I type an object with known and unknown keys in TypeScript — Roberto Zvjerković
– Roberto Zvjerković, Commented Jun 23, 2021 at 9:15
I have tried this: ``` type Attr = { [key: string]: string }; interface Attributes extends Attr { "!!!ExactlyOneOtherStringPropertyNoMoreNoLess!!!": string[]; } ``` But it does not work either. Same error: ``` (property) Attributes["!!!ExactlyOneOtherStringPropertyNoMoreNoLess!!!"]: string[] Property '"!!!ExactlyOneOtherStringPropertyNoMoreNoLess!!!"' of type 'string[]' is not assignable to string index type 'string' ``` — Alberto Valero
– Alberto Valero, Commented Jun 23, 2021 at 13:20
I think tis answer is revelant stackoverflow.com/a/61434547/11637098 — Toothgip
– Toothgip, Commented May 24, 2023 at 13:21

Luiz Ferraz · Accepted Answer · 2021-06-24 00:59:02Z

3

Index signature like that requires that every possible value matches that signature. If you want that as a fallback you have to do an intersection with a in string signature:

type IColumn = {
  name: string;
  key: string;
  attributes: { [key in string]: string }
    & { options: string[] };
  shortable: boolean;
};

Or using the nice aliases in the standard library:

type IColumn = {
  name: string;
  key: string;
  attributes: Record<string, string> & { options: string[] };
  shortable: boolean;
};

If you think you might have this pattern in multiple places you can make a helper type like this:

export type WithDefault<Default, T extends Record<string, any>> = Record<string, Default> & T;

type IColumn = {
  name: string;
  key: string;
  attributes: WithDefault<string, {
    options: string[],
    someFlag: boolean,
  }>;
  shortable: boolean;
};

answered Jun 24, 2021 at 0:59

Luiz Ferraz

1,56510 silver badges13 bronze badges

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

2 Comments

Alberto Valero Over a year ago

First and second do not kork, I don't know why :( Property 'options' is incompatible with index signature. Type 'string[]' is not assignable to type 'string'

throrin19 Over a year ago

None of this works : ts type Inputs = WithDefault<number | null, { timeserie: [string, number][] }> ``` const timeserie: [string, number][] = [ [faker.date.recent().toISOString(), faker.number.int()], [faker.date.recent().toISOString(), faker.number.int()], [faker.date.recent().toISOString(), faker.number.int()], ]; const inputs: Inputs = { timeserie, A : null, }; ``` Error TS2345

Collectives™ on Stack Overflow

Typescript object with [key: string]: string | string[]

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related