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

{
  "anchor": "kebabcase",
  "name": "kebabcase",
  "category": "String",
  "description": "Takes the `value` string, and turns it into kebab-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 kebab-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)"
      }
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "examples": [
    {
      "title": "kebab-case a string without specifying original case",
      "source": "kebabcase(\"InputString\")",
      "return": "input-string"
    },
    {
      "title": "kebab-case a snake_case string",
      "source": "kebabcase(\"foo_bar_baz\", \"snake_case\")",
      "return": "foo-bar-baz"
    },
    {
      "title": "kebab-case specifying the wrong original case (noop)",
      "source": "kebabcase(\"foo_bar_baz\", \"PascalCase\")",
      "return": "foo_bar_baz"
    }
  ],
  "pure": true
}