Class CharacterSetCreator

Static ReadonlyMAXIMUM_STRING_LENGTH

constructor

• new CharacterSetCreator(characterSet, ...exclusionSupport): CharacterSetCreator

• Constructor.

  Parameters

  • characterSet: readonly string[]

    Character set. Each element is a single-character string, unique within the array, that defines the character set.
  • Rest...exclusionSupport: readonly Exclusion[]

    Exclusions supported by the character set. All character sets implicitly support Exclusion.None.

  Returns CharacterSetCreator

StaticpowerOf10

• powerOf10(power): bigint

• Get a power of 10.

  Parameters

  • power: number

    Power.

  Returns bigint

  10**power.

create

• create(length, value, exclusion?, tweak?, creationCallback?): string

• Create a string by mapping a value to the equivalent characters in the character set across the length of the string.

  Parameters

  • length: number

    Required string length.
  • value: number | bigint

    Numeric value of the string.
  • Optionalexclusion: Exclusion

    Strings to be excluded from the range of outputs. See Exclusion for possible values and their meaning.
  • Optionaltweak: number | bigint

    If provided, the numerical value of the string is "tweaked" using an encryption transformer.
  • OptionalcreationCallback: CreationCallback

    If provided, called after the string is constructed to create the final value.

  Returns string

  String created from the value.
• create(length, values, exclusion?, tweak?, creationCallback?): IterableIterator<string, any, any>

• Create multiple strings by mapping each value to the equivalent characters in the character set across the length of the string. Equivalent to calling this method for each individual value.

  Parameters

  • length: number

    Required string length.
  • values: Iterable<number | bigint, any, any>

    Numeric values of the strings.
  • Optionalexclusion: Exclusion

    Strings to be excluded from the range of outputs. See Exclusion for possible values and their meaning.
  • Optionaltweak: number | bigint

    If provided, the numerical value of the strings are "tweaked" using an encryption transformer.
  • OptionalcreationCallback: CreationCallback

    If provided, called after each string is constructed to create the final value.

  Returns IterableIterator<string, any, any>

  Iterable iterator over strings created from the values.
• create(length, valueOrValues, exclusion?, tweak?, creationCallback?): string | IterableIterator<string, any, any>

• Create a string or multiple strings. This signature exists to allow similar overloaded methods in other classes to call this method correctly.

  Parameters

  • length: number
  • valueOrValues: number | bigint | Iterable<number | bigint, any, any>
  • Optionalexclusion: Exclusion
  • Optionaltweak: number | bigint
  • OptionalcreationCallback: CreationCallback

  Returns string | IterableIterator<string, any, any>

valueFor

• valueFor(s, exclusion?, tweak?): bigint

• Determine the value for a string.

  Parameters

  • s: string

    String.
  • exclusion: Exclusion = Exclusion.None

    Strings excluded from the range of inputs. See Exclusion for possible values and their meaning.
  • Optionaltweak: number | bigint

    If provided, the numerical value of the string was "tweaked" using an encryption transformer.

  Returns bigint

  Numeric value of the string.