Class CharacterSetCreator

Static ReadonlyMAXIMUM_STRING_LENGTH

constructor

• new CharacterSetCreator(
      characterSet: readonly string[],
      ...exclusionSupport: readonly Exclusion[],
  ): CharacterSetCreator

• Constructor.

  Parameters

  • characterSet: readonly string[]

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

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

  Returns CharacterSetCreator

StaticpowerOf10

• powerOf10(power: number): bigint

• Get a power of 10.

  Parameters

  • power: number

    Power.

  Returns bigint

  10**power.

create

• create<TTransformerInput extends TransformerInput<number | bigint>>(
      length: number,
      valueOrValues: TTransformerInput,
      exclusion?: Exclusion,
      tweak?: number | bigint,
      creatorCallback?: TransformerCallback<string, string>,
  ): TransformerOutput<TTransformerInput, string>

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

  Type Parameters

  • TTransformerInput extends TransformerInput<number | bigint>

  Parameters

  • length: number

    Required string length.
  • valueOrValues: TTransformerInput

    Numeric value(s) of the string(s).
  • exclusion: Exclusion = Exclusion.None

    String(s) 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(s) is/are "tweaked" using an encryption transformer.
  • OptionalcreatorCallback: TransformerCallback<string, string>

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

  Returns TransformerOutput<TTransformerInput, string>

  String(s) created from the value(s).

valueFor

• valueFor(s: string, exclusion?: Exclusion, tweak?: number | bigint): 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.