github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/variables/PARAMS_doc.yaml (about)

     1  - DocumentID: params
     2    Title: >-
     3      `PARAMS` (json)
     4    CategoryID: variables
     5    Summary: >-
     6      Array of the parameters within a given scope
     7    Description: |-
     8      `PARAMS` returns an array of the parameters within a given scope.
     9      eg `function`, `private`, `autocomplete` or shell script.
    10  
    11      Unlike `$ARGV`, `$PARAMS` does not include the function name.
    12  
    13      This is a reserved variable so it cannot be changed.
    14    Examples: |-
    15      ```
    16      » function example { $PARAMS }
    17      » example abc 1 2 3
    18      [
    19          "abc",
    20          "1",
    21          "2",
    22          "3"
    23      ]
    24      ```
    25    Synonyms:
    26    - params
    27    - PARAMS
    28    Related:
    29    - argv
    30    - set
    31    - json
    32    - string
    33    - array
    34    - function
    35    - private
    36    - autocomplete
    37    - out
    38    - scoping
    39    - pipeline
    40    - modules
    41    - reserved-vars