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

{
  "anchor": "encode_punycode",
  "name": "encode_punycode",
  "category": "Codec",
  "description": "Encodes a `value` to [punycode](https://en.wikipedia.org/wiki/Punycode). Useful for internationalized domain names ([IDN](https://en.wikipedia.org/wiki/Internationalized_domain_name)). This function assumes that the value passed is meant to be used in IDN context and that it is either a domain name or a part of it.",
  "arguments": [
    {
      "name": "value",
      "description": "The string to encode.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "validate",
      "description": "Whether to validate the input string to check if it is a valid domain name.",
      "required": false,
      "type": [
        "boolean"
      ],
      "default": "true"
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "internal_failure_reasons": [
    "`value` can not be encoded to `punycode`"
  ],
  "examples": [
    {
      "title": "Encode an internationalized domain name",
      "source": "encode_punycode!(\"www.café.com\")",
      "return": "www.xn--caf-dma.com"
    },
    {
      "title": "Encode an internationalized domain name with mixed case",
      "source": "encode_punycode!(\"www.CAFé.com\")",
      "return": "www.xn--caf-dma.com"
    },
    {
      "title": "Encode an ASCII only string",
      "source": "encode_punycode!(\"www.cafe.com\")",
      "return": "www.cafe.com"
    },
    {
      "title": "Ignore validation",
      "source": "encode_punycode!(\"xn--8hbb.xn--fiba.xn--8hbf.xn--eib.\", validate: false)",
      "return": "xn--8hbb.xn--fiba.xn--8hbf.xn--eib."
    }
  ],
  "pure": true
}