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

{
  "anchor": "slice",
  "name": "slice",
  "category": "String",
  "description": "Returns a slice of `value` between the `start` and `end` positions.\n\nIf the `start` and `end` parameters are negative, they refer to positions counting from the right of the\nstring or array. If `end` refers to a position that is greater than the length of the string or array,\na slice up to the end of the string or array is returned.",
  "arguments": [
    {
      "name": "value",
      "description": "The string or array to slice.",
      "required": true,
      "type": [
        "string",
        "array"
      ]
    },
    {
      "name": "start",
      "description": "The inclusive start position. A zero-based index that can be negative.",
      "required": true,
      "type": [
        "integer"
      ]
    },
    {
      "name": "end",
      "description": "The exclusive end position. A zero-based index that can be negative.",
      "required": false,
      "type": [
        "integer"
      ],
      "default": "String length"
    }
  ],
  "return": {
    "types": [
      "string",
      "array"
    ]
  },
  "examples": [
    {
      "title": "Slice a string (positive index)",
      "source": "slice!(\"Supercalifragilisticexpialidocious\", start: 5, end: 13)",
      "return": "califrag"
    },
    {
      "title": "Slice a string (negative index)",
      "source": "slice!(\"Supercalifragilisticexpialidocious\", start: 5, end: -14)",
      "return": "califragilistic"
    },
    {
      "title": "String start",
      "source": "slice!(\"foobar\", 3)",
      "return": "bar"
    },
    {
      "title": "Array start",
      "source": "slice!([0, 1, 2], 1)",
      "return": [
        1,
        2
      ]
    }
  ],
  "pure": true
}