Class CharacterSetValidator

Character set validator. Validates a string against a specified character set.

Hierarchy (View Summary)

Implements

Constructors

constructor

Accessors

characterSet characterSetSize exclusionSupport

Methods

character characterIndex characterIndexes validateExclusion validate

Constructors

constructor

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

  • 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 CharacterSetValidator

Accessors

characterSet

  • get characterSet(): readonly string[]

  • Get the character set.

    Returns readonly string[]

characterSetSize

  • get characterSetSize(): number

  • Get the character set size.

    Returns number

exclusionSupport

Methods

character

  • character(index: number): string

  • Get the character at an index.

    Parameters

    • index: number

      Index into the character set.

    Returns string

    Character at the index.

characterIndex

  • characterIndex(c: string): undefined | number

  • Get the index for a character.

    Parameters

    • c: string

      Character.

    Returns undefined | number

    Index for the character or undefined if the character is not in the character set.

characterIndexes

  • characterIndexes(s: string): readonly (undefined | number)[]

  • Get the indexes for all characters in a string.

    Parameters

    • s: string

      String.

    Returns readonly (undefined | number)[]

    Array of indexes for each character or undefined if the character is not in the character set.

ProtectedvalidateExclusion

  • validateExclusion(exclusion: Exclusion): void

  • Validate that an exclusion is supported. If not, an error is thrown.

    Parameters

    Returns void

validate

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods