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

{
  "anchor": "basename",
  "name": "basename",
  "category": "String",
  "description": "Returns the filename component of the given `path`. This is similar to the Unix `basename` command. If the path ends in a directory separator, the function returns the name of the directory.",
  "arguments": [
    {
      "name": "value",
      "description": "The path from which to extract the basename.",
      "required": true,
      "type": [
        "string"
      ]
    }
  ],
  "return": {
    "types": [
      "string",
      "null"
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a valid string."
  ],
  "examples": [
    {
      "title": "Extract basename from file path",
      "source": "basename!(\"/usr/local/bin/vrl\")",
      "return": "vrl"
    },
    {
      "title": "Extract basename from file path with extension",
      "source": "basename!(\"/home/user/file.txt\")",
      "return": "file.txt"
    },
    {
      "title": "Extract basename from directory path",
      "source": "basename!(\"/home/user/\")",
      "return": "user"
    },
    {
      "title": "Root directory has no basename",
      "source": "basename!(\"/\")",
      "return": null
    }
  ],
  "pure": true
}