Understanding Varargs in Kotlin Functions

Hello and welcome! Today, we will delve into an intriguing topic—the varargs in Kotlin. This feature enables us to pass a variable number of arguments to a function, in a manner similar to a shopping list of varying lengths. We will discuss varargs, their syntax, rules in Kotlin, and how they operate within Kotlin functions. An exciting journey awaits us, so let's get started!

Let's demystify varargs. They grant us the ability to pass any number of arguments to a function, resembling an array that bypasses the need for array creation by allowing the direct passage of arguments. The keyword vararg is your ticket to expressing variable arguments in Kotlin:

fun greet(vararg names: String) {
    // code...
}

Now, you are prepared to call greet with any number of argument strings or even no argument:

greet("Alice", "Bob", "Charlie")
greet()

Now it's showtime for varargs in your functions. As a refresher, the vararg keyword can capture a flexible quantity of arguments. A function can include only one vararg parameter, which must be positioned last if additional parameters exist. Here's an example of a function that prints a greeting before a variable quantity of names:

fun printNames(greeting: String, vararg names: String) {
    for (name in names) {
        println("$greeting, $name")
    }
}

printNames("Hello", "Alice", "Bob", "Charlie")  // It will print "Hello, Alice", "Hello, Bob" and "Hello, Charlie" on separate lines.

Sometimes we have an existing array instance in Kotlin, and we want to pass it to a function accepting a vararg. In those situations, to decompose the array to a vararg, we can use the spread operator:

fun printNames(vararg names: String) {
    for (name in names) {
        println(name)
    }
}

val names = arrayOf("Alice", "Bob", "Charlie")
printNames(*names)

The * in front of the names argument is the spread operator.