TypeScript reusable function arguments type

Question

I have a function that is defined as so:

function getRangeBounds(start: number, stop?: number, step?: number) {
  if (step === undefined) step = 1;
  const actualStart = start !== undefined && stop !== undefined ? start : 0;
  const actualStop = stop === undefined ? start : stop;
  return [actualStart, actualStop, step];
}

I want this function's arguments to be typed and be reusable. So I did:

type Range = Parameters<typeof getRangeBounds>;

I want the type Range to be reusable across a couple more functions, namely range and mapRange that will have the following signatures respectively:

export function range(...args: Range): ReadonlyArray<number> {
  /* this will call getRangeBounds at some point */
}

export function mapRange(...rangeArgs: Range, mapper: MapFunc<number> = IdentityMapper) {
  return range(rangeArgs).map(mapper); /* code does not compile */
}

How can I make these functions behave in a way the contract Range is honored by them all and also be possible to use extra args in some functions like the mapRange above?

Edit: I fixed the compilation error above, so mapRange looks like this now:

export function mapRange(rangeArgs: Range, mapper: MapFunc<number>) {
  return range(...rangeArgs).map(mapper);
}

But I now need to call the function like this:

mapRange([start, stop, step])

Not sure exactly what you mean. range(...args: Range) is a good solution, you could also destruture the parameters in the argument list if you want: range(...[start, stop, step]: Range) — Titian Cernicova-Dragomir
– Titian Cernicova-Dragomir, Commented Jul 6, 2020 at 8:24

ford04 · Accepted Answer · 2020-07-06 10:27:16Z

2

Some options to add extra parameters to Range for other functions:

Option 1: Change rest parameter to be the last element

function mapRangeRest(mapper: MapFunc<number>, ...rangeArgs: Range) { ... }

mapRangeRest(mapFunc, 1)
mapRangeRest(mapFunc, 1, 2)

Option 2: Currying

function mapRangeCurry(...rangeArgs: Range_): (mapper: MapFunc<number>) { ... }

mapRangeCurry(1)(mapFunc)
mapRangeCurry(1, 2)(mapFunc)

Option 3 (TS 4.0): Variadic tuples

function mapRangeVT<T extends Range_>(...rangeArgs: [...T, MapFunc<number>]) {...}

mapRangeVT(1, mapFunc)
mapRangeVT(1, 2, mapFunc)

If you can update to the latest TS version, option 3 probably fits best, as function shape is not changed.

Play sample

answered Jul 6, 2020 at 10:27

ford04

75.8k26 gold badges219 silver badges176 bronze badges

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

1 Comment

hyde Over a year ago

Optional 3 is truly the way I was looking for. Thanks!

Collectives™ on Stack Overflow

TypeScript reusable function arguments type

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related