Idea: 'rest' index signatures and the 'error' type

[This idea is still in a relatively early stage of development, but I thought it may be of worth to someone or even for the TS team itself. Feel free to share your thoughts]

Having literal types, or unions of them, in index signatures is an idea that was brought to discussion lately (see #5683, #7656 and more general discussion in #7660):

interface Example {
    [letter: "a" | "b" | "c"]: number;
}

However the conventional semantics of index signatures would imply that the type checking here would be very weak, unless noImplicitAny is enabled:

let x: Example;

x["a"] = 123; // OK
x["a"] = "ABCD"; // Error: type 'string' cannot be assigned to 'number'

x["d"] = 123; // No error with noImplicitAny disabled
x["d"] = "ABCD"; // No error with noImplicitAny disabled

x[123] = "ABCD"; // No error with noImplicitAny disabled
x[Symbol("ABCD")] = true; // No error with noImplicitAny disabled

let y = x["a"] // OK, 'y' gets type 'number'
let y = x["d"] // No error with noImplicitAny disabled, 'y' gets type 'any'
let y = x[123] // No error with noImplicitAny disabled, 'y' gets type 'any'
let y = x[Symbol("ABCD")] // No error with noImplicitAny disabled, 'y' gets type 'any'

What if it there was a way to specify the type of all the 'remaining' access keys to the interface with a special "rest" index signature (notated as [key: ...any]: T) that would set a particular type for everything other than that was specified in the interface?

interface Example {
    [letter: "a" | "b" | "c"]: number;
    [otherKeys: ...any]: string;
}

This may also be useful to avoid unwanted type errors when noImplicitAny is enabled:

interface Example {
    [letter: "a" | "b" | "c"]: number;
    [otherKeys: ...any]: any;
}

And what if it would be set to some sort of an 'error' type? I.e. a type that would not be assignable to or from anything? (perhaps except itself, still thinking about it..).

interface Example {
    [letter: "a" | "b" | "c"]: number;
    [otherKeys: ...any]: <Error>;
}

With the <Error> type, any assignment to or from a key that is not "a", "b" or "c" would yield an error, as it cannot be assigned to or from anything:

let x: Example;

x["a"] = 123; // OK
x["a"] = "ABCD"; // Error: type 'string' is not assignable to 'number'

x["d"] = 123; // Error: type 'number' is not assignable to '<Error>'
x["d"] = "ABCD"; // Error: type 'string' is not assignable to '<Error>'

x[123] = "ABCD"; // Error: type 'string' is not assignable to '<Error>'
x[Symbol("ABCD")] = true; // Error: type 'boolean' is not assignable to '<Error>'

let y = x["a"] // OK, 'y' gets type 'number'
let y = x["d"] // Error: type '<Error>' cannot be assigned to anything
let y = x[123] // Error: type '<Error>' cannot be assigned to anything
let y = x[Symbol("ABCD")] // Error: type '<Error>' cannot be assigned to anything

Or even:

x["d"] = <null> {}; // Error: type  'null' is not assignable to '<Error>'
x["d"] = <undefined> {}; // Error: type 'undefined' is not assignable to '<Error>'
x["d"] = <void> {}; // Error: type 'void' is not assignable to '<Error>'
x["d"] = <any> {}; // Error: type 'any' is not assignable to '<Error>'

Open questions:

What would be the implications in terms of indexing into an entity having this signature in its type?
What would be the implications in terms of assigning to an entity having this signature in its type?
What would be the implications in terms of assigning from an entity having this signature in its type?
Would adding [key: any...]: <Error> convert any interface to a "strict" interface? (i.e. one that cannot be assigned from a 'wider' type containing more properties). And if it would, would that be seen as desirable or useful?

Edits: expanded and corrected examples to the actual behavior with noImplicitAny enabled.
Edits: converted from 'bottom' to <Error> as I seemed to have used a less common interpretation of the 'bottom' type
Edits (13 May 2016): changed [...] to [key: ...any] for better consistency with the current syntax.

I'm rethinking my use of the "bottom" type here [Edit: modified the text to use <Error> instead for now]. In any case what I meant was simply a type that is not assignable to or from anything.

Wikipedia says the "bottom" type may be used:

"To signal that a function or computation diverges; in other words, does not return a result to the caller. (This does not necessarily mean that the program fails to terminate; a subroutine may terminate without returning to its caller, or exit via some other means such as a continuation.) "

Or

"As an indication of error; this usage primarily occurs in theoretical languages where distinguishing between errors is unimportant. Production programming languages typically use other methods, such as option types (including tagged pointers) or exception handling."

So I guess the second is closer to what I meant, though this may not be the most common meaning.

If anyone has a better suggestion to a type that "cannot be assigned to or from anything" (this includes to or from any, void undefined and null), please mention it.

Edit: still thinking about whether one <Error> type should be assignable to another <Error> type..

Another problem with string literals in index signature keys (and "normal" properties as well), is that is not possible to define:

interface Example {
    [letter: "a" | "b" | "c"]: number;
    [key: string]: boolean; // <-- Error
}

That wouldn't work, as the second index signature conflicts with the first one. As a possible solution, what if there were specialized 'rest' signatures that only included the 'rest' of a particular key type, like:

interface Example {
    [letter: "a" | "b" | "c"]: number;
    [key: ...string]: boolean;
}

This can be useful with regular properties as well since even today this produces an error:

interface Example {
    a: number; // <-- Error, not assignable to index signature
    b: number; // <-- Error, not assignable to index signature
    c: number; // <-- Error, not assignable to index signature

    [key: string]: boolean;
}

(The same would happen if all properties were optional)

So a typed 'rest' index signature would allow specifying all other string keys:

interface Example {
    a: number; // OK
    b: number; // OK
    c: number; // OK

    [key: ...string]: boolean;
}

Wait, what? I was utterly surprised when I found out that I can't do this:

export interface VNodeStyle {
  delayed: { [prop: string]: string }
  [prop: string]: string
}

because I would get

[ts] Property 'delayed' of type '{ [prop: string]: string; }' is not assignable to string index type 'string'.

So, whatever. Fix it please. Yet, how would I get around it?

You can try:

export type VNodeStyle = { delayed: { [prop: string]: string } } & { [prop: string]: string };

SlurpTheo

SlurpTheo it's the same as one interface. The only difference is that interface shows the error right away but alias shows the error when you try to create a variable

const test: VNodeStyle = {
  delayed: { hello: "World" },
  rest: "Hi",
};

TS2322: Type '{ delayed: { hello: string; }; rest: string; }' is not assignable to type 'VNodeStyle'.
   Type '{ delayed: { hello: string; }; rest: string; }' is not assignable to type '{ [prop: string]: string; }'.
     Property 'delayed' is incompatible with index signature.
       Type '{ hello: string; }' is not assignable to type 'string'.

I was also surprised it doesn't work.

I need to create an interface with props that a component receives from redux-form Fields. In my case field names are dynamic (provided by user).

interface IFieldNames {
  field1: string;
  field2: string;
}

interface IMyComponentProps {
  customProp1: string;
  customProp2: boolean;
  customPropFieldNames: IFieldNames;
  [field: ...string]: { input: {...}; meta: {...} };
}

const fieldNamesProvidedByUser: IFieldNames = ...;

<Fields
  names={Object.values(fieldNamesProvidedByUser)}
  component={MyComponent}
  customProp1="stringProp"
  customProp2={true}
  customPropFieldNames={fieldNamesProvidedByUser}
/>

then in component I do

const { customProp1, customProp2, customPropFieldNames, ...props } = this.props;
const field1Props = props[customPropFieldNames.field1]; // {input: {...}, meta: {...}}
const field2Props = props[customPropFieldNames.field2];

Is this feature ever coming?

Navigation Menu

Repository navigation

Idea: 'rest' index signatures and the 'error' type #7765

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Idea: 'rest' index signatures and the 'error' type #7765

Description

Activity

malibuzios commented on Apr 1, 2016

malibuzios commented on Apr 2, 2016

mightyiam commented on Apr 5, 2017

mightyiam commented on Apr 5, 2017

SlurpTheo commented on Apr 7, 2017

01e9 commented on Dec 21, 2019

ivands commented on Dec 4, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions