Template:Is Discord ID/doc: Difference between revisions
documentate |
No edit summary |
||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
== Usage and behavior == | == Usage and behavior == | ||
<code>{&123;Is Discord ID|''input to test''|ifNo=''output if no (optional)''|ifYes=''output if yes (optional)''}}</code> | <code>{{Is Discord ID|''input to test''|ifNo=''output if no (optional)''|ifYes=''output if yes (optional)''}}</code> | ||
* <code>''input to test''</code> - Required. What will be checked to see if it is a valid Discord ID. A yes condition will be returned if this | * <code>''input to test''</code> - Required. What will be checked to see if it is a valid Discord ID. A yes condition will be returned if this parameter is a string consisting solely of 8-20 decimal digits. | ||
* <code>|ifNo=</code> - Optional. What the template will output if the input is not a valid Discord ID. If not specified, an empty string will be returned. | * <code>|ifNo=</code> - Optional. What the template will output if the input is not a valid Discord ID. If not specified, an empty string will be returned. | ||
* <code>|ifYes=</code> - Optional. What the template will output if the input is a valid Discord ID. If not specified or the value is <code>INPUT</code>, the <code>''input to test''</code> will be returned, stripped of any whitespace. | * <code>|ifYes=</code> - Optional. What the template will output if the input is a valid Discord ID. If not specified or the value is <code>INPUT</code>, the <code>''input to test''</code> will be returned, stripped of any whitespace. |
Latest revision as of 02:04, 19 July 2023
This template tests whether a given input is a valid Discord Snowflake (aka ID). This template is intended for use to process arguments in other templates; there isn't really a reason to use it directly in articles.
Usage and behavior[edit source]
{{Is Discord ID|input to test|ifNo=output if no (optional)|ifYes=output if yes (optional)}}
input to test
- Required. What will be checked to see if it is a valid Discord ID. A yes condition will be returned if this parameter is a string consisting solely of 8-20 decimal digits.|ifNo=
- Optional. What the template will output if the input is not a valid Discord ID. If not specified, an empty string will be returned.|ifYes=
- Optional. What the template will output if the input is a valid Discord ID. If not specified or the value isINPUT
, theinput to test
will be returned, stripped of any whitespace.
For example, {{Is Discord ID|501310750074077215}}
will return 501310750074077215, while {{Is Discord ID|obama|ifNo=false}}
will return false.
TemplateData[edit source]
This template tests whether a given input is a valid Discord Snowflake (aka ID). This template is intended for use to process arguments in other templates; there isn't really a reason to use it directly in articles.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Input | 1 | The string to test whether it's a valid ID.
| String | required |
ifNo | ifNo | What the template would output if it's not a valid Discord ID.
| String | optional |
ifYes | ifYes | What the template would output if it is a valid Discord ID.
| String | optional |