Numeric (str)

Variables who's name is a positive integer, eg 0, 1, 2, 3 and above

Description

Variables named 0 and above are the equivalent index value of @ARGV.

These are reserved variables so they cannot be changed.

Examples

» function example { out $0 $2 }
» example 1 2 3
example 2

Detail

0 (str)

This returns the name of the executable (like $ARGS[0])

1, 2, 3... (str)

This returns parameter n (like $ARGS[n]). If there is no parameter n then the variable will not be set thus the upper limit variable is determined by how many parameters are set. For example if you have 19 parameters passed then variables $1 through to $19 (inclusive) will all be set.

See Also

• Define Variable (set): Define a variable (typically local) and set it's value
• Output String (out): Print a string to the stdout with a trailing new line character
• Private Function (private): Define a private function block
• Public Function (function): Define a function block
• Tab Autocompletion (autocomplete): Set definitions for tab-completion in the command line
• ARGV (json): Array of the command name and parameters within a given scope
• PARAMS (json): Array of the parameters within a given scope
• str (string): string (primitive)

---

This document was generated from gen/variables/numeric_doc.yaml.