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

{
  "anchor": "snakecase",
  "name": "snakecase",
  "category": "String",
  "description": "Takes the `value` string, and turns it into snake_case. Optionally, you can pass in the existing case of the function, or else we will try to figure out the case automatically.",
  "arguments": [
    {
      "name": "value",
      "description": "The string to convert to snake_case.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "original_case",
      "description": "Optional hint on the original case type. Must be one of: kebab-case, camelCase, PascalCase, SCREAMING_SNAKE, snake_case",
      "required": false,
      "type": [
        "string"
      ],
      "enum": {
        "kebab-case": "[kebab-case](https://en.wikipedia.org/wiki/Letter_case#Kebab_case)",
        "camelCase": "[camelCase](https://en.wikipedia.org/wiki/Camel_case)",
        "PascalCase": "[PascalCase](https://en.wikipedia.org/wiki/Camel_case)",
        "SCREAMING_SNAKE": "[SCREAMING_SNAKE](https://en.wikipedia.org/wiki/Snake_case)",
        "snake_case": "[snake_case](https://en.wikipedia.org/wiki/Snake_case)"
      }
    },
    {
      "name": "excluded_boundaries",
      "description": "Case boundaries to exclude during conversion.",
      "required": false,
      "type": [
        "array"
      ],
      "enum": {
        "lower_upper": "Lowercase to uppercase transitions (e.g., 'camelCase' → 'camel' + 'case')",
        "upper_lower": "Uppercase to lowercase transitions (e.g., 'CamelCase' → 'Camel' + 'Case')",
        "acronym": "Acronyms from words (e.g., 'XMLHttpRequest' → 'xmlhttp' + 'request')",
        "lower_digit": "Lowercase to digit transitions (e.g., 'foo2bar' → 'foo2_bar')",
        "upper_digit": "Uppercase to digit transitions (e.g., 'versionV2' → 'version_v2')",
        "digit_lower": "Digit to lowercase transitions (e.g., 'Foo123barBaz' → 'foo' + '123bar' + 'baz')",
        "digit_upper": "Digit to uppercase transitions (e.g., 'Version123Test' → 'version' + '123test')"
      }
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "examples": [
    {
      "title": "snake_case a string",
      "source": "snakecase(\"input-string\")",
      "return": "input_string"
    },
    {
      "title": "snake_case a string with original case",
      "source": "snakecase(\"input-string\", original_case: \"kebab-case\")",
      "return": "input_string"
    },
    {
      "title": "snake_case with excluded boundaries",
      "source": "snakecase(\"s3BucketDetails\", excluded_boundaries: [\"lower_digit\"])",
      "return": "s3_bucket_details"
    }
  ],
  "pure": true
}