Class NonNumericIdentificationKeyValidator

Non-numeric identification key validator.

Hierarchy

Constructors

constructor

Accessors

requiresCheckCharacterPair identificationKeyType prefixType length referenceCharacterSet referenceCreator

Methods

creatorFor validate padIdentificationKey validatePrefix

Constructors

constructor

Accessors

requiresCheckCharacterPair

  • get requiresCheckCharacterPair(): boolean

  • Determine if the identification key requires a check character pair.

    Returns boolean

identificationKeyType

prefixType

length

  • get length(): number

  • Returns number

    Inherit Doc

referenceCharacterSet

referenceCreator

Methods

Protected StaticcreatorFor

validate

ProtectedpadIdentificationKey

  • padIdentificationKey(
        identificationKey: string,
        validation: undefined | IdentificationKeyValidation,
    ): string

  • Pad an identification key on the left with zero-value character for validation purposes. This is done to align an identification key with a position offset for any error message that may be thrown by the reference validator.

    Parameters

    • identificationKey: string

      Identification key.

    • validation: undefined | IdentificationKeyValidation

      Identification key validation parameters.

    Returns string

    Padded identification key.

ProtectedvalidatePrefix

  • validatePrefix(partialIdentificationKey: string, positionOffset?: number): void

  • Validate the prefix within an identification key.

    Parameters

    • partialIdentificationKey: string

      Partial identification key.

    • OptionalpositionOffset: number

      Position offset within a larger string.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods