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
46
47
48
49
50
51
52
53

{
  "anchor": "ceil",
  "name": "ceil",
  "category": "Number",
  "description": "Rounds the `value` up to the specified `precision`.",
  "arguments": [
    {
      "name": "value",
      "description": "The number to round up.",
      "required": true,
      "type": [
        "integer",
        "float"
      ]
    },
    {
      "name": "precision",
      "description": "The number of decimal places to round to.",
      "required": false,
      "type": [
        "integer"
      ],
      "default": "0"
    }
  ],
  "return": {
    "types": [
      "integer",
      "float"
    ],
    "rules": [
      "Returns an integer if `precision` is `0` (this is the default). Returns a float otherwise."
    ]
  },
  "examples": [
    {
      "title": "Round a number up (without precision)",
      "source": "ceil(4.345)",
      "return": 5.0
    },
    {
      "title": "Round a number up (with precision)",
      "source": "ceil(4.345, precision: 2)",
      "return": 4.35
    },
    {
      "title": "Round an integer up (noop)",
      "source": "ceil(5)",
      "return": 5
    }
  ],
  "pure": true
}