typescript 2.2 interfaces extend object type

Question

I have function using an object as parameter like this:

interface Options {
    foo?: string;
    bar?: number;
};

function fooNction(opts: Options): void {
}

This works fine in some cases but not all:

fooNction({foo: "s"});   // OK
fooNction({a: "x"});     // fine as TS gives an Error as expected
fooNction("hello");      // no Error...

I tried to extend my interface from TS 2.2 object type like this

interface Options extends object {
    foo?: string;
    bar?: number;
};

to disallow basic types but typescript tells "Cannot fine name 'object'".

Is there any way to define an interfaces has to be an object but has no mandatory field?

artem · Accepted Answer · 2017-03-11 00:30:17Z

12

For some reason, it's not allowed to have an interface that extends built-in type like object or string. You may try to bypass that by declaring type alias for object like this

type ObjectAlias = object;

interface Options extends ObjectAlias {
   ...
}

but it still does not work because structural compatibility is used for typechecking interfaces:

function fooNction(opts: Options): void {
}

fooNction("hello"); //ok

So it seems like object is usable only with intersection types, and you must declare Options as a type, not an interface to make it work:

type  Options = object & {
    foo?: string;
    bar?: number;
};

function fooNction(opts: Options): void {
}

fooNction("hello"); //error

answered Mar 11, 2017 at 0:30

artem

52.2k10 gold badges86 silver badges85 bronze badges

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

Collectives™ on Stack Overflow

typescript 2.2 interfaces extend object type

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