vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

{
  "anchor": "mod",
  "name": "mod",
  "category": "Number",
  "description": "Calculates the remainder of `value` divided by `modulus`.",
  "arguments": [
    {
      "name": "value",
      "description": "The value the `modulus` is applied to.",
      "required": true,
      "type": [
        "integer",
        "float"
      ]
    },
    {
      "name": "modulus",
      "description": "The `modulus` value.",
      "required": true,
      "type": [
        "integer",
        "float"
      ]
    }
  ],
  "return": {
    "types": [
      "integer",
      "float"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not an integer or float.",
    "`modulus` is not an integer or float.",
    "`modulus` is equal to 0."
  ],
  "examples": [
    {
      "title": "Calculate the remainder of two integers",
      "source": "mod(5, 2)",
      "return": 1
    }
  ],
  "pure": true
}