how to extend Array<T> in typescript

Question

in the post of "Typescript extend String Static", I got the a few that we can extend existing baseclass of typescript, for example, add new method

interface StringConstructor {
   isNullOrEmpty(str:string):boolean;
}
String.isNullOrEmpty = (str:string) => !str;

it really does work. but for generic interface, I met problems. for example, I need to add new method contain() in Array. I use the following code:

   //1
    interface Array<T> {
        contain(item: T): boolean;
    }  
    //2
    ?????? = (item: T) => {
    // ....
        return true;
    };

after step1, in VS intellisense does and pop up contain method, but where can I do implement method?

Possible duplicate of Extending Array in TypeScript

Rikki Gibson
– Rikki Gibson

2017-02-28 19:19:45 +00:00
Commented Feb 28, 2017 at 19:19 — Rikki Gibson
– Rikki Gibson, Commented Feb 28, 2017 at 19:19

Nitzan Tomer · Accepted Answer · 2017-01-15 09:49:02Z

7

As the definition in the interface is already bound to the generic constraint, in the implementation you can just treat it as any:

interface Array<T> {
    contain(item: T): boolean;
}  

Array.prototype.contain = function(item) {
    return this.some(obj => item == obj);
};

Also, do not use arrow functions for prototype methods, here's why:

interface Array<T> {
    fn(): void;
}

Array.prototype.fn = () => {
    console.log(this);
};

let a = [];
a.fn(); // Window

But:

Array.prototype.fn = function() {
    console.log(this);
};

let a = [];
a.fn(); // []

If you're targeting es5 or lower then it doesn't matter as the compiler translates arrow functions into regular ones, but if you will then switch to targeting es6 (and the arrow functions will persist) then your code will break and you won't understand why.

edited Jan 15, 2017 at 9:49

answered Jan 15, 2017 at 8:41

Nitzan Tomer

166k51 gold badges330 silver badges307 bronze badges

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

6 Comments

VinceDan Over a year ago

hi Nitzan, thanks your answer... if implement it as a instance method, it should be the same as in .net framework. I found whether use arrow function or not, the intellisense hint the parameter item is any, and no array itself which must be used in method body.. any suggestion about get array in method body?

Nitzan Tomer Over a year ago

Is it supposed to be an instance method or a static method? It makes sense based on the signature you posted that it's an instance method. The item is what you're looking for inside the array no? If so, it is supposed to be any

VinceDan Over a year ago

I like to do it by instance method because I am .net developer..:-) my concern is in method body, I can not get array[], I need array[] and item which has been passed in to write contains logic...

Nitzan Tomer Over a year ago

The array is just this because you are adding this method to the Array object prototype. As in my example: return this.some(obj => item == obj). The this.some method is the Array.prototype.some method.

VinceDan Over a year ago

got it. all I do is based on vs intellisense, but it does not work here...thanks again Nitzan..

|

Collectives™ on Stack Overflow

how to extend Array<T> in typescript

1 Answer 1

6 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related