|
| 1 | +--- |
| 2 | +layout: recipe |
| 3 | +title: Splat Arguments |
| 4 | +chapter: Functions |
| 5 | +--- |
| 6 | + |
| 7 | +h2. Problem |
| 8 | + |
| 9 | +Your function will be called with a varying number of arguments. |
| 10 | + |
| 11 | +h2. Solution |
| 12 | + |
| 13 | +Use _splats_. |
| 14 | + |
| 15 | +{% highlight coffeescript %} |
| 16 | +loadTruck = (firstDibs, secondDibs, tooSlow...) -> |
| 17 | + truck: |
| 18 | + driversSeat: firstDibs |
| 19 | + passengerSeat: secondDibs |
| 20 | + trunkBed: tooSlow |
| 21 | + |
| 22 | +loadTruck("Amanda", "Joel") |
| 23 | +# => { truck: { driversSeat: "Amanda", passengerSeat: "Joel", trunkBed: [] } } |
| 24 | + |
| 25 | +loadTruck("Amanda", "Joel", "Bob", "Mary", "Phillip") |
| 26 | +# => { truck: { driversSeat: "Amanda", passengerSeat: "Joel", trunkBed: ["Bob", "Mary", "Phillip"] } } |
| 27 | +{% endhighlight %} |
| 28 | + |
| 29 | +With a trailing argument: |
| 30 | + |
| 31 | +{% highlight coffeescript %} |
| 32 | +loadTruck = (firstDibs, secondDibs, tooSlow..., leftAtHome) -> |
| 33 | + truck: |
| 34 | + driversSeat: firstDibs |
| 35 | + passengerSeat: secondDibs |
| 36 | + trunkBed: tooSlow |
| 37 | + taxi: |
| 38 | + passengerSeat: leftAtHome |
| 39 | + |
| 40 | +loadTruck("Amanda", "Joel", "Bob", "Mary", "Phillip", "Austin") |
| 41 | +# => { truck: { driversSeat: "Amanda", passengerSeat: "Joel", trunkBed: ["Bob", "Mary", "Phillip"] }, taxi: "Austin" } |
| 42 | +{% endhighlight %} |
| 43 | + |
| 44 | +loadTruck("Amanda") |
| 45 | +# => { truck: { driversSeat: "Amanda", passengerSeat: undefined, trunkBed: [] }, taxi: undefined } |
| 46 | + |
| 47 | +h2. Discussion |
| 48 | + |
| 49 | +By adding an ellipsis ("...") next to no more than one of a function's arguments, CoffeeScript will combine all of the argument values not captured by other named arguments into a list. It will serve up an empty list even if some of the named arguments were not supplied. |
| 50 | + |
0 commit comments