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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

{
  "anchor": "compact",
  "name": "compact",
  "category": "Enumerate",
  "description": "Compacts the `value` by removing empty values, where empty values are defined using the available parameters.",
  "arguments": [
    {
      "name": "value",
      "description": "The object or array to compact.",
      "required": true,
      "type": [
        "object",
        "array"
      ]
    },
    {
      "name": "recursive",
      "description": "Whether the compaction be recursive.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    },
    {
      "name": "null",
      "description": "Whether null should be treated as an empty value.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    },
    {
      "name": "string",
      "description": "Whether an empty string should be treated as an empty value.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    },
    {
      "name": "object",
      "description": "Whether an empty object should be treated as an empty value.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    },
    {
      "name": "array",
      "description": "Whether an empty array should be treated as an empty value.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    },
    {
      "name": "nullish",
      "description": "Tests whether the value is \"nullish\" as defined by the [`is_nullish`](#is_nullish) function.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "false"
    }
  ],
  "return": {
    "types": [
      "object",
      "array"
    ],
    "rules": [
      "The return type matches the `value` type."
    ]
  },
  "examples": [
    {
      "title": "Compact an object with default parameters",
      "source": "compact({\"field1\": 1, \"field2\": \"\", \"field3\": [], \"field4\": null})",
      "return": {
        "field1": 1
      }
    },
    {
      "title": "Compact an array with default parameters",
      "source": "compact([\"foo\", \"bar\", \"\", null, [], \"buzz\"])",
      "return": [
        "foo",
        "bar",
        "buzz"
      ]
    },
    {
      "title": "Compact an array using nullish",
      "source": "compact([\"-\", \"   \", \"\\n\", null, true], nullish: true)",
      "return": [
        true
      ]
    },
    {
      "title": "Compact a complex object with default parameters",
      "source": "compact({ \"a\": {}, \"b\": null, \"c\": [null], \"d\": \"\", \"e\": \"-\", \"f\": true })",
      "return": {
        "e": "-",
        "f": true
      }
    },
    {
      "title": "Compact a complex object using null: false",
      "source": "compact({ \"a\": {}, \"b\": null, \"c\": [null], \"d\": \"\", \"e\": \"-\", \"f\": true }, null: false)",
      "return": {
        "b": null,
        "c": [
          null
        ],
        "e": "-",
        "f": true
      }
    }
  ],
  "pure": true
}