Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  • Back to home
  • Dynamic values Modules
  • Airline
  • Animal
  • Color
  • Commerce
  • Company
  • Database
  • Datatype
  • Date
  • Finance
  • Food
  • Git
  • Hacker
  • Helpers
  • Image
  • Internet
  • Location
  • Lorem
  • Music
  • Number
  • Person
  • Phone
  • Science
  • String
  • System
  • Vehicle
  • Word

String

Module to generate string related entries.
Overview
For a string containing just A-Z characters, use {{$string.alpha}}. To add digits too, use {{$string.alphanumeric}}. If you only want punctuation marks/symbols, use {{$string.symbol}}. For a full set of ASCII characters, use {{$string.sample}}. For a custom set of characters, use {{$string.fromCharacters}}.
For strings of base-ten digits, use {{$string.numeric}}. For other bases, use {{$string.binary}}, {{$string.octal}}, or {{$string.hexadecimal}}).
You can generate standard ID strings using {{$string.uuid}} or {{$string.nanoid}}.
Related modules
Emoji can be found at {{$internet.emoji}}.
The Helpers module includes a number of string related methods.

alpha#

Generating a string consisting of letters in the English alphabet.
Parameters
NameTypeDefaultDescription
casingCasingmixedThe casing of the characters.
excludestring | Array<AlphaChar | string>[]An array with characters which should be excluded in the generated string.
minnumber1The minimum number of characters to generate.
maxnumber1The maximum number of characters to generate.
lengthnumber1The range of characters to generate.
Returns: string
Examples

alphanumeric#

Generating a string consisting of alpha characters and digits.
Parameters
NameTypeDefaultDescription
casingCasingmixedThe casing of the characters.
excludestring | Array<AlphaNumericChar | string>[]An array with characters which should be excluded in the generated string.
minnumber1The minimum number of characters to generate.
maxnumber1The maximum number of characters to generate.
lengthnumber1The range of characters to generate.
Returns: string
Examples

binary#

Returns a binary string.
Parameters
NameTypeDefaultDescription
prefixstring0bPrefix for the generated number.
minnumber1The minimum number of characters to generate after the prefix.
maxnumber1The maximum number of characters to generate after the prefix.
lengthnumber1The range of characters to generate.
Returns: string
Examples

fromCharacters#

Generates a string from the given characters.
Parameters
NameTypeDefaultDescription
charactersstring | string[]The characters to use for the string. Can be a string or an array of characters. If it is an array, then each element is treated as a single character even if it is a string with multiple characters.
minnumberThe minimum length of the string to generate.
maxnumberThe maximum length of the string to generate.
Returns: string
Examples

hexadecimal#

Returns a hexadecimal string.
Parameters
NameTypeDefaultDescription
casingCasingmixedThe casing of the characters.
prefixstring0xPrefix for the generated number.
minnumber1The minimum number of characters to generate after the prefix.
maxnumber1The maximum number of characters to generate after the prefix.
lengthnumber1The range of characters to generate after the prefix.
Returns: string
Examples

nanoid#

Generates a Nano ID.
Parameters
NameTypeDefaultDescription
minnumber1The minimum length of the Nano ID to generate.
maxnumber1The maximum length of the Nano ID to generate.
lengthnumber21Length of the generated string.
Returns: string
Examples

numeric#

Generates a given length string of digits.
Parameters
NameTypeDefaultDescription
excludestring | Array<NumericChar | string>[]An array of digits which should be excluded in the generated string.
allowLeadingZerosbooleantrueWhether leading zeros are allowed or not.
minnumber1The minimum of digits to generate.
maxnumber1The maximum of digits to generate.
lengthnumber1The range of digits to generate.
Returns: string
Examples

octal#

Returns an octal string.
Parameters
NameTypeDefaultDescription
minnumber1The minimum of digits to generate after the prefix.
maxnumber1The maximum of digits to generate after the prefix.
lengthnumber1The range of digits to generate after the prefix.
prefixstring0oPrefix for the generated number.
Returns: string
Examples

sample#

Returns a string containing UTF-16 chars between 33 and 125 (! to }).
Parameters
NameTypeDefaultDescription
minnumberThe minimum number of characters to generate.
maxnumberThe maximum number of characters to generate.
Returns: string
Examples

symbol#

Returns a string containing only special characters from the following list:
Parameters
NameTypeDefaultDescription
minnumberThe minimum number of special characters to generate.
maxnumberThe maximum number of special characters to generate.
Returns: string
Examples

uuid#

Returns a UUID v4 (Universally Unique Identifier).
Returns: string
Examples
Modified atΒ 2024-09-02 06:43:20
Previous
Science
Next
System
Built with