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
54
55
56
57
58
59
60
61

{
  "anchor": "array",
  "name": "array",
  "category": "Type",
  "description": "Returns `value` if it is an array, otherwise returns an error. This enables the type checker to guarantee that the returned value is an array and can be used in any function that expects an array.",
  "arguments": [
    {
      "name": "value",
      "description": "The value to check if it is an array.",
      "required": true,
      "type": [
        "any"
      ]
    }
  ],
  "return": {
    "types": [
      "array"
    ],
    "rules": [
      "Returns the `value` if it's an array.",
      "Raises an error if not an array."
    ]
  },
  "internal_failure_reasons": [
    "`value` is not an array."
  ],
  "examples": [
    {
      "title": "Declare an array type",
      "source": "array!(.value)",
      "input": {
        "value": [
          1,
          2,
          3
        ]
      },
      "return": [
        1,
        2,
        3
      ]
    },
    {
      "title": "Valid array literal",
      "source": "array([1,2,3])",
      "return": [
        1,
        2,
        3
      ]
    },
    {
      "title": "Invalid type",
      "source": "array!(true)",
      "raises": "function call error for \"array\" at (0:12): expected array, got boolean"
    }
  ],
  "pure": true
}