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

{
  "anchor": "bool",
  "name": "bool",
  "category": "Type",
  "description": "Returns `value` if it is a Boolean, otherwise returns an error. This enables the type\nchecker to guarantee that the returned value is a Boolean and can be used in any\nfunction that expects a Boolean.",
  "arguments": [
    {
      "name": "value",
      "description": "The value to check if it is a Boolean.",
      "required": true,
      "type": [
        "any"
      ]
    }
  ],
  "return": {
    "types": [
      "boolean"
    ],
    "rules": [
      "Returns `value` if it's a Boolean.",
      "Raises an error if not a Boolean."
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a Boolean."
  ],
  "examples": [
    {
      "title": "Valid Boolean",
      "source": "bool(false)",
      "return": false
    },
    {
      "title": "Invalid Boolean",
      "source": "bool!(42)",
      "raises": "function call error for \"bool\" at (0:9): expected boolean, got integer"
    },
    {
      "title": "Valid Boolean from path",
      "source": "bool!(.value)",
      "input": {
        "value": true
      },
      "return": true
    }
  ],
  "pure": true
}