github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/variables/params.md (about)

     1  # `PARAMS` (json)
     2  
     3  > Array of the parameters within a given scope
     4  
     5  ## Description
     6  
     7  `PARAMS` returns an array of the parameters within a given scope.
     8  eg `function`, `private`, `autocomplete` or shell script.
     9  
    10  Unlike `$ARGV`, `$PARAMS` does not include the function name.
    11  
    12  This is a reserved variable so it cannot be changed.
    13  
    14  
    15  
    16  ## Examples
    17  
    18  ```
    19  » function example { $PARAMS }
    20  » example abc 1 2 3
    21  [
    22      "abc",
    23      "1",
    24      "2",
    25      "3"
    26  ]
    27  ```
    28  
    29  ## Synonyms
    30  
    31  * `params`
    32  * `PARAMS`
    33  
    34  
    35  ## See Also
    36  
    37  * [Array (`@`) Token](../parser/array.md):
    38    Expand values as an array
    39  * [Modules and Packages](../user-guide/modules.md):
    40    An introduction to Murex modules and packages
    41  * [Pipeline](../user-guide/pipeline.md):
    42    Overview of what a "pipeline" is
    43  * [Reserved Variables](../user-guide/reserved-vars.md):
    44    Special variables reserved by Murex
    45  * [Variable and Config Scoping](../user-guide/scoping.md):
    46    How scoping works within Murex
    47  * [`ARGV` (json)](../variables/argv.md):
    48    Array of the command name and parameters within a given scope
    49  * [`autocomplete`](../commands/autocomplete.md):
    50    Set definitions for tab-completion in the command line
    51  * [`function`](../commands/function.md):
    52    Define a function block
    53  * [`json`](../types/json.md):
    54    JavaScript Object Notation (JSON)
    55  * [`out`](../commands/out.md):
    56    Print a string to the STDOUT with a trailing new line character
    57  * [`private`](../commands/private.md):
    58    Define a private function block
    59  * [`set`](../commands/set.md):
    60    Define a local variable and set it's value
    61  * [`string` (stringing)](../types/str.md):
    62    string (primitive)
    63  
    64  <hr/>
    65  
    66  This document was generated from [gen/variables/PARAMS_doc.yaml](https://github.com/lmorg/murex/blob/master/gen/variables/PARAMS_doc.yaml).