Rest Parameters of Functions

Back to: TypeScript Tutorial

Rest parameters in JavaScript and TypeScript allow you to pass an indefinite number of arguments to a function as an array. This can be useful when you don’t know how many arguments will be passed, or when you want to provide a more flexible API to users of your function.

In TypeScript, rest parameters are denoted with the ... syntax followed by a parameter name. The parameter name can be any valid identifier, but it’s common to use args or rest.

Declaring Rest Parameters of Functions in TypeScript:

Here’s an example of declaring rest parameters in TypeScript:

function sum(...nums: number[]) {
  return nums.reduce((total, num) => total + num, 0);
}

console.log(sum(1, 2, 3, 4)); // outputs 10
console.log(sum(10, 20)); // outputs 30

In this example, we declare a function called sum that takes an indefinite number of arguments as an array of numbers using the rest parameter syntax. We then use the reduce method to sum up the numbers in the array and return the total.

Using Rest Parameters of Functions in TypeScript:

Once you’ve declared rest parameters in a function, you can use them like any other array. Here’s an example of using rest parameters in TypeScript:

function logAll(prefix: string, ...values: any[]) {
  console.log(prefix, ...values);
}

logAll("Message:", 1, "hello", { name: "John" }); // outputs "Message: 1 hello { name: 'John' }"

In this example, we declare a function called logAll that takes a prefix string and an indefinite number of values as rest parameters. We then use the spread operator ... to log the prefix and all the values to the console.

Top FAQs on Rest Parameters of Functions in TypeScript:

What is a rest parameter in TypeScript?

A rest parameter in TypeScript allows you to pass an indefinite number of arguments to a function as an array. It’s denoted with the ... syntax followed by a parameter name.

How do you declare a rest parameter in TypeScript?

To declare a rest parameter in TypeScript, use the ... syntax followed by a parameter name. The parameter name can be any valid identifier, but it’s common to use args or rest.

What is the difference between a rest parameter and an arguments object?

A rest parameter is an array of values, while the arguments object is an array-like object that contains all the arguments passed to a function. Rest parameters provide a more flexible and type-safe way of working with an indefinite number of arguments.

Can you use rest parameters with other parameters in TypeScript?

Yes, you can use rest parameters with other parameters in TypeScript. Rest parameters must come last in the parameter list, but you can have other parameters before them.

How do you use rest parameters to call another function in TypeScript?

To use rest parameters to call another function in TypeScript, use the spread operator ... to expand the rest parameter array into individual arguments. You can then pass these arguments to another function using the spread operator again.

In conclusion, rest parameters in TypeScript provide a powerful and flexible way to work with an indefinite number of arguments passed to a function. With rest parameters, you can create more reusable and type-safe functions that can handle different numbers of arguments without sacrificing functionality or readability.

Rest parameters are denoted with the ... syntax in TypeScript, and they can be used in combination with other parameters or with other TypeScript features like interfaces and classes. Rest parameters can also be used with the spread operator to call other functions with an array of arguments.

By understanding the basics of rest parameters in TypeScript and practicing their usage through examples, you can improve the quality and efficiency of your code and make it more adaptable to different scenarios.