numeric →
add(
    value: numeric,
    times: integer = 1
) → numeric

Returns the sum of the input value and the parameter value.

Parameters

Name Type Required Description
value numeric Yes The value to add to the input value.
times integer No Number of times the addition is applied. Defaults to 1.

Argument evaluation

  • value: Evaluated once in the enclosing context.
  • times: Evaluated once in the enclosing context.

Behavior

Argument form — value and times: Value expressions: literals, references, or expression pipelines, such as 5, .bonus, or 5 | multiply(2). times defaults to 1; the result is input + value × times.

Enclosing context: Both arguments retain the surrounding expression context. Field references read its contextual record, independently of the number entering add. For example, {price:=10, bonus:=3} | .price | add(.bonus) returns 13: the pipeline input to add is 10, while .bonus reads 3 from the surrounding record.

Examples

10 | add(5)       15
10 | add(5, 2)    20

Kind: Function
Scope: numeric/arithmetic
Aliases: numeric-to-add


This site uses Just the Docs, a documentation theme for Jekyll.