How do default parameters work in TypeScript functions?

Default parameters in TypeScript functions provide a way to initialize function parameters with default values if no value or undefined is passed during the function call. This feature enhances code readability and maintainability by reducing the need for additional checks or conditional statements to handle cases where parameters are not provided.

When defining a function, you can assign a default value to a parameter by using the assignment operator (=) followed by the desired value. If the caller does not provide a value for that parameter, the default value will be used instead. This is particularly useful in scenarios where certain parameters are optional, allowing developers to create more flexible and robust functions.

Syntax of Default Parameters

function functionName(param1: type = defaultValue, param2: type = defaultValue): returnType {
    // function body
}

Example of Default Parameters

function greet(name: string = "Guest", age: number = 18): string {
    return `Hello, ${name}. You are ${age} years old.`;
}

console.log(greet()); // Output: Hello, Guest. You are 18 years old.
console.log(greet("Alice")); // Output: Hello, Alice. You are 18 years old.
console.log(greet("Bob", 25)); // Output: Hello, Bob. You are 25 years old.

Best Practices

• Use Descriptive Default Values: When setting default values, ensure they are meaningful and provide context. For instance, using "Guest" for a name parameter is more informative than using an empty string.
• Keep Functions Focused: Avoid overloading functions with too many parameters, even with defaults. If a function has too many optional parameters, consider breaking it down into smaller functions.
• Document Default Values: Clearly document the purpose of default values in your function comments or documentation. This helps other developers understand the intended use of the function.

Common Mistakes

• Using Undefined as a Default Value: If a parameter is explicitly set to undefined when calling the function, the default value will not be used. For example, greet(undefined) will output "Hello, undefined. You are 18 years old."
• Overusing Default Parameters: While default parameters can simplify function calls, overusing them can lead to confusion. Ensure that the function's purpose remains clear and that default values do not obscure its intent.
• Type Mismatch: Ensure that the default value matches the expected type of the parameter. For example, if a parameter is expected to be a string, providing a number as a default value will lead to type errors.

In conclusion, default parameters in TypeScript are a powerful feature that can simplify function definitions and enhance code clarity. By following best practices and avoiding common pitfalls, developers can create more efficient and user-friendly functions.