Extending Array in TypeScript for specific type

Question

I know how to extend array for any type:

declare global {
  interface Array<T> {
    remove(elem: T): Array<T>;
  }
}

if (!Array.prototype.remove) {
  Array.prototype.remove = function<T>(this: T[], elem: T): T[] {
    return this.filter(e => e !== elem);
  }
}

Source: Extending Array in TypeScript

But is there also a way to extend the array only for a specific type?. Like only for arrays of type User -> Array<User>.

I want to create a extend method, like .toUsersMap() and this method should not be displayed for arrays, which have not the type User.

captain-yossarian from Ukraine · Accepted Answer · 2021-08-15 09:19:22Z

3

You can achieve similar behaviour:

type User = {
  tag: 'User'
}

interface Array<T> {
  toUsersMap: T extends User ? (elem: T) => Array<T> : never
}

declare var user: User;

const arr = [user]

arr.toUsersMap(user) // ok

const another_array = [{ notUser: true }]

another_array.toUsersMap() // This expression is not callable

If T parameter does not extends User, TS will disallow using toUsersMap

Playground

answered Aug 15, 2021 at 9:19

captain-yossarian from Ukraine

33.5k5 gold badges41 silver badges78 bronze badges

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

2 Comments

jcalz Over a year ago

You can also use a this parameter like so.

captain-yossarian from Ukraine Over a year ago

@jcalz I believe your solution is much better than mine. Please provide an answer

jcalz · Accepted Answer · 2021-08-17 02:03:26Z

I don't think there's a way to completely suppress the IntelliSense prompting for toUsersMap() on Arrays, but you can definitely make it a compiler error to call arr.toUsersMap() unless arr is assignable to Array<User>. One way to do this is to give the toUsersMap() method a this parameter:

interface Array<T> {
  toUsersMap(this: Array<User>): Map<string, User>;
}

Now the compiler will require that toUsersMap() only be called with a this context of something assignable to Array<User>:

interface User {
  username: string;
}
const arr = [{ username: "foo" }, { username: "bar" }];
arr.toUsersMap() // okay, no error

const another_array = ["hello", 123];
another_array.toUsersMap() // error, 
//~~~~~~~~~~~ <--
// The 'this' context of type '{ notUser: boolean; }[]' is 
// not assignable to method's 'this' of type 'User[]'

Playground link to code

Collectives™ on Stack Overflow

Extending Array in TypeScript for specific type

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related