Interface: ensureRepeatingCharacterOptions

ensureRepeatingCharacterOptions

Interface object that represents the 'Ensure Repeating Characters Option' object used by the Ensure Repeating Characters Function.

Properties:
NameTypeAttributesDescription
repeatingSetCountnumber<optional>

A number defining the amount of pre-generated characters to repeat.

customCharacterSetstring | Array.<Array.<string>><optional>

A string input containing characters that should be repeated in the password. This attribute can be formatted in three ways:

  1. A standard string input (abc); where each character will be repeated 2 times.
  2. A (standalone) custom repeating set (a:4); requesting "a" to be repeated 4 times.
  3. A custom repeating set (a b:1 c:3 ::4 3f:10);
    • requesting "a" to be repeated 2 times,
    • repeats of "1" are converted to 2, so "b" gets repeated 2 times,
    • requesting "c" to be repeated 3 times,
    • literal characters such as ":" (colon) and "" (forward-slash) can be prefixed with a "" (forward-slash),
    • only the first character in a repeating set will be used, so "3" will be repeated 10 times.
preservationsrepeatingCharacterOptionsPreservations<optional>

An object that defines if the beginning and end characters of the returned password should be preserved. If not set the positions of these characters will be lost.

Source: