PARAMS (json)

Array of the parameters within a given scope

Description

PARAMS returns an array of the parameters within a given scope. eg function, private, autocomplete or shell script.

Unlike $ARGV, $PARAMS does not include the function name.

This is a reserved variable so it cannot be changed.

Examples

» function example { $PARAMS }
» example abc 1 2 3
[
    "abc",
    "1",
    "2",
    "3"
]

Other Reserved Variables

• Numeric (str): Variables who's name is a positive integer, eg 0, 1, 2, 3 and above
• $., Meta Values (json): State information for iteration blocks
• ARGV (json): Array of the command name and parameters within a given scope
• COLUMNS (int): Character width of terminal
• EVENT_RETURN (json): Return values for events
• HOSTNAME (str): Hostname of the current machine
• MUREX_ARGV (json): Array of the command name and parameters passed to the current shell
• MUREX_EXE (path): Absolute path to running shell
• PARAMS (json): Array of the parameters within a given scope
• PWDHIST (json): History of each change to the sessions working directory
• PWD (path): Current working directory
• SELF (json): Meta information about the running scope.
• SHELL (str): Path of current shell

See Also

• Modules And Packages: An introduction to Murex modules and packages
• Pipeline: Overview of what a "pipeline" is
• Reserved Variables: Special variables reserved by Murex
• Variable and Config Scoping: How scoping works within Murex
• @Array Sigil: Expand values as an array
• ARGV (json): Array of the command name and parameters within a given scope
• autocomplete: Set definitions for tab-completion in the command line
• function: Define a function block
• json: JavaScript Object Notation (JSON)
• out: Print a string to the stdout with a trailing new line character
• private: Define a private function block
• set: Define a local variable and set it's value
• string (stringing): string (primitive)

---

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