{"route":"/en-US-v0.14.1/reference/foundations/arguments/","title":"Arguments","description":"Documentation for the Arguments type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"argument-sinks","name":"Argument Sinks","children":[]},{"id":"spreading","name":"Spreading","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-arguments","name":"arguments","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-key","name":"key","children":[]},{"id":"definitions-at-default","name":"default","children":[]}]},{"id":"definitions-pos","name":"Positional","children":[]},{"id":"definitions-named","name":"Named","children":[]}]}],"body":{"kind":"type","content":{"name":"arguments","title":"Arguments","keywords":[],"oneliner":"Captured arguments to a function.","details":"

Captured arguments to a function.

\n

Argument Sinks

\n

Like built-in functions, custom functions can also take a variable number of\narguments. You can specify an argument sink which collects all excess\narguments as ..sink. The resulting sink value is of the arguments\ntype. It exposes methods to access the positional and named arguments.

\n
#let format(title, ..authors) = {\n  let by = authors\n    .pos()\n    .join(", ", last: " and ")\n\n  [*#title* \\ _Written by #by;_]\n}\n\n#format("ArtosFlow", "Jane", "Joe")\n
\"Preview\"
\n

Spreading

\n

Inversely to an argument sink, you can spread arguments, arrays and\ndictionaries into a function call with the ..spread operator:

\n
#let array = (2, 3, 5)\n#calc.min(..array)\n#let dict = (fill: blue)\n#text(..dict)[Hello]\n
\"Preview\"
","constructor":{"path":[],"name":"arguments","title":"Construct","keywords":[],"oneliner":"Construct spreadable arguments in place.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Construct spreadable arguments in place.

\n

This function behaves like let args(..sink) = sink.

"},{"kind":"example","content":{"body":"
#let args = arguments(stroke: red, inset: 1em, [Body])\n#box(..args)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"arguments","details":[{"kind":"html","content":"

The arguments to construct.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["arguments"],"scope":[]},"scope":[{"path":["arguments"],"name":"at","title":"At","keywords":[],"oneliner":"Returns the positional argument at the specified index, or the named argument with the specified name.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the positional argument at the specified index, or the named\nargument with the specified name.

\n

If the key is an integer, this is equivalent to first calling\npos and then array.at. If it is a string,\nthis is equivalent to first calling named and then\ndictionary.at.

"}],"self":true,"params":[{"name":"key","details":[{"kind":"html","content":"

The index or name of the argument to get.

"}],"types":["int","str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"default","details":[{"kind":"html","content":"

A default value to return if the key is invalid.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["arguments"],"name":"pos","title":"Positional","keywords":[],"oneliner":"Returns the captured positional arguments as an array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the captured positional arguments as an array.

"}],"self":true,"params":[],"returns":["array"],"scope":[]},{"path":["arguments"],"name":"named","title":"Named","keywords":[],"oneliner":"Returns the captured named arguments as a dictionary.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the captured named arguments as a dictionary.

"}],"self":true,"params":[],"returns":["dictionary"],"scope":[]}]}}}