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

{
  "anchor": "truncate",
  "name": "truncate",
  "category": "String",
  "description": "Truncates the `value` string up to the `limit` number of characters.",
  "arguments": [
    {
      "name": "value",
      "description": "The string to truncate.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "limit",
      "description": "The number of characters to truncate the string after.",
      "required": true,
      "type": [
        "integer"
      ]
    },
    {
      "name": "suffix",
      "description": "A custom suffix to be appended to truncated strings. If a custom `suffix` is\nprovided, the total length of the string will be `limit + <suffix length>`.",
      "required": false,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string"
    ],
    "rules": [
      "The string is returned unchanged its length is less than `limit`."
    ]
  },
  "examples": [
    {
      "title": "Truncate a string",
      "source": "truncate(\"A rather long sentence.\", limit: 11, suffix: \"...\")",
      "return": "A rather lo..."
    },
    {
      "title": "Truncate a string (custom suffix)",
      "source": "truncate(\"A rather long sentence.\", limit: 11, suffix: \"[TRUNCATED]\")",
      "return": "A rather lo[TRUNCATED]"
    },
    {
      "title": "Truncate",
      "source": "truncate(\"foobar\", 3)",
      "return": "foo"
    }
  ],
  "pure": true
}