Skip to content

Commit c0abe98

Browse files
sirainencmouse
authored andcommitted
variables: Change filter formatting
1 parent bcb4b2b commit c0abe98

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

docs/core/settings/variables.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -97,44 +97,44 @@ Bytes output type indicates that the output will be tagged as binary output. Sub
9797

9898
| Filter | Input | Output | Description |
9999
| ------ | ----- | ------ | ----------- |
100-
| base64(pad=boolean, url=boolean) | Bytes | String | Base64 encode given input, defaults to pad and not url scheme. |
101-
| benumber | Bytes | Number | Convert big-endian encoded input into a number. |
102-
| concat(any, any...) | Bytes | Bytes | Concatenates input with value(s). Numbers are coerced to strings. Input is optional. |
103-
| decrypt(key=bytes, iv=bytes, raw=boolean, algorithm=string) | Any | Any | Decrypts given input, see [cryptography support](#cryptography-support). |
104-
| decrypt(key=string, salt=string, rounds=number, raw=boolean, hash=string, algorithm=string) | Any | Any | Decrypts given input, see [cryptography support](#cryptography-support). |
105-
| default(value) | String | String | Replace empty or missing input with value. Clears missing variable error. If no value is provided, empty string is used. |
106-
| domain | String | String | Provides domain part of user@domain value. |
107-
| encrypt(key=bytes, iv=bytes, raw=boolean, algorithm=string) | Any | Any | Encrypts given input, see [cryptography support](#cryptography-support). |
108-
| encrypt(key=string, salt=string, rounds=number, raw=boolean, hash=string, algorithm=string) | Any | Any | Encrypts given input, see [cryptography support](#cryptography-support). |
109-
| hash(method, rounds=number, salt=string) | Bytes | Bytes | Returns raw hash from input using given hash method. Rounds and salt are optional. |
110-
| hexlify(width) | Bytes | String | Convert bytes into hex with optional width, truncates or pads up to width. |
111-
| hex(width) | Number | Number | Convert base-10 number to base-16 number. If width is specified the result is truncated or padded with 0 to width. Negative width is applied after number. |
112-
| if(left, operator, right, true, false) | String | String | Evaluates given comparison and returns true or false value. See [conditionals](#conditionals). |
113-
| if(operator, right, true, false) | String | String | Evaluates given comparison against input value and retuns true or false value. |
114-
| index(separator, nth) | String | String | Returns nth element from separator separated string. Zero based. Negative values are looked relative to end of list. |
115-
| ldap_dn | String | String | Converts `domain.com` to `dc=domain,dc=com`. |
116-
| lenumber | Bytes | Number| Convert little-endian encoded input into a number. |
117-
| lfill(width, filler) | Any | Any | Pads value from left with filler until length is width. Default filler is `0`. |
118-
| list(separator) | String | String | Converts tab-escaped list into separator separated list. Defaults to `,`. |
119-
| literal(string) | None | String | Expands into literally the value. If variable is used, works like lookup. Input is ignored. |
120-
| lookup(name) | None | String | Lookup var from table. If var is variable, the name is taken from variable's contents. Input is ignored. |
121-
| lower | String | String | Lowercases input. |
122-
| md5(rounds=number, salt=string) | Bytes | Bytes | Alias for hash with method md5. |
123-
| regexp(expression, replacement) | String | String |Performs regular expression replacement using [POSIX Extended Regular Expression syntax](https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002dextended-regular-expression-syntax.html). Supports up to 9 capture groups. |
124-
| reverse | Any | Any | Reverse input bytes. |
125-
| rfill(width, filler) | Any | Any | Pads value to right with filler until length is width. Default filler is `0`. |
126-
| sha1(rounds=number, salt=string) | Bytes | Bytes | Alias for hash with method sha1. |
127-
| sha256(rounds=number, salt=string) | Bytes | Bytes | Alias for hash with method sha256. |
128-
| sha384(rounds=number, salt=string) | Bytes | Bytes | Alias for hash with method sha384. |
129-
| sha512(rounds=number, salt=string) | Bytes | Bytes | Alias for hash with method sha512. |
130-
| substr(offset, length) | Any | Any | Extracts a substring out of input and returns it. First character is at offset zero. If offset is negative, starts that far back from the end of the string. If length is omitted, returns everything through the end of the string. If length is negative, leaves that many characters off the end of the string. |
131-
| text | Bytes | String | Sanitize input into text and clear binary tag. |
132-
| truncate(len, bits=number) | Bytes | Bytes | Truncate to len bytes, or number of bits. The parameters are mutually exclusive. |
133-
| unbase64(pad=boolean, url=boolean) | String | Bytes | Base64 decode given input, defaults to pad and not url scheme. |
134-
| unhex | String | Number | Convert base-16 number to base-10 number. |
135-
| unhexlify | String | Bytes | Convert hex encoded input into bytes. |
136-
| upper | String | String | Uppercases input. |
137-
| username | String | String | Provides user part of user@domain value. |
100+
| `base64(pad=boolean, url=boolean)` | Bytes | String | Base64 encode given input, defaults to pad and not url scheme. |
101+
| `benumber` | Bytes | Number | Convert big-endian encoded input into a number. |
102+
| `concat(any, any...)` | Bytes | Bytes | Concatenates input with value(s). Numbers are coerced to strings. Input is optional. |
103+
| `decrypt(key=bytes, iv=bytes, raw=boolean, algorithm=string)` | Any | Any | Decrypts given input, see [cryptography support](#cryptography-support). |
104+
| `decrypt(key=string, salt=string, rounds=number, raw=boolean, hash=string, algorithm=string)` | Any | Any | Decrypts given input, see [cryptography support](#cryptography-support). |
105+
| `default(value)` | String | String | Replace empty or missing input with value. Clears missing variable error. If no value is provided, empty string is used. |
106+
| `domain` | String | String | Provides domain part of user@domain value. |
107+
| `encrypt(key=bytes, iv=bytes, raw=boolean, algorithm=string)` | Any | Any | Encrypts given input, see [cryptography support](#cryptography-support). |
108+
| `encrypt(key=string, salt=string, rounds=number, raw=boolean, hash=string, algorithm=string)` | Any | Any | Encrypts given input, see [cryptography support](#cryptography-support). |
109+
| `hash(method, rounds=number, salt=string)` | Bytes | Bytes | Returns raw hash from input using given hash method. Rounds and salt are optional. |
110+
| `hexlify(width)` | Bytes | String | Convert bytes into hex with optional width, truncates or pads up to width. |
111+
| `hex(width)` | Number | Number | Convert base-10 number to base-16 number. If width is specified the result is truncated or padded with 0 to width. Negative width is applied after number. |
112+
| `if(left, operator, right, true, false)` | String | String | Evaluates given comparison and returns true or false value. See [conditionals](#conditionals). |
113+
| `if(operator, right, true, false)` | String | String | Evaluates given comparison against input value and retuns true or false value. |
114+
| `index(separator, nth)` | String | String | Returns nth element from separator separated string. Zero based. Negative values are looked relative to end of list. |
115+
| `ldap_dn` | String | String | Converts `domain.com` to `dc=domain,dc=com`. |
116+
| `lenumber` | Bytes | Number | Convert little-endian encoded input into a number. |
117+
| `lfill(width, filler)` | Any | Any | Pads value from left with filler until length is width. Default filler is `0`. |
118+
| `list(separator)` | String | String | Converts tab-escaped list into separator separated list. Defaults to `,`. |
119+
| `literal(string)` | None | String | Expands into literally the value. If variable is used, works like lookup. Input is ignored. |
120+
| `lookup(name)` | None | String | Lookup var from table. If var is variable, the name is taken from variable's contents. Input is ignored. |
121+
| `lower` | String | String | Lowercases input. |
122+
| `md5(rounds=number, salt=string)` | Bytes | Bytes | Alias for hash with method md5. |
123+
| `regexp(expression, replacement)` | String | String |Performs regular expression replacement using [POSIX Extended Regular Expression syntax](https://www.gnu.org/software/findutils/manual/html_node/find_html/posix_002dextended-regular-expression-syntax.html). Supports up to 9 capture groups. |
124+
| `reverse` | Any | Any | Reverse input bytes. |
125+
| `rfill(width, filler)` | Any | Any | Pads value to right with filler until length is width. Default filler is `0`. |
126+
| `sha1(rounds=number, salt=string)` | Bytes | Bytes | Alias for hash with method sha1. |
127+
| `sha256(rounds=number, salt=string)` | Bytes | Bytes | Alias for hash with method sha256. |
128+
| `sha384(rounds=number, salt=string)` | Bytes | Bytes | Alias for hash with method sha384. |
129+
| `sha512(rounds=number, salt=string)` | Bytes | Bytes | Alias for hash with method sha512. |
130+
| `substr(offset, length)` | Any | Any | Extracts a substring out of input and returns it. First character is at offset zero. If offset is negative, starts that far back from the end of the string. If length is omitted, returns everything through the end of the string. If length is negative, leaves that many characters off the end of the string. |
131+
| `text` | Bytes | String | Sanitize input into text and clear binary tag. |
132+
| `truncate(len, bits=number)` | Bytes | Bytes | Truncate to len bytes, or number of bits. The parameters are mutually exclusive. |
133+
| `unbase64(pad=boolean, url=boolean)` | String | Bytes | Base64 decode given input, defaults to pad and not url scheme. |
134+
| `unhex` | String | Number | Convert base-16 number to base-10 number. |
135+
| `unhexlify` | String | Bytes | Convert hex encoded input into bytes. |
136+
| `upper` | String | String | Uppercases input. |
137+
| `username` | String | String | Provides user part of user@domain value. |
138138

139139
## Global providers
140140

0 commit comments

Comments
 (0)