Class NonNumericIdentificationKeyValidator

Non-numeric identification key validator.

Hierarchy

Constructors

constructor

Accessors

requiresCheckCharacterPair identificationKeyType prefixType length referenceCharacterSet referenceValidator

Methods

validatorFor padIdentificationKey validate validatePrefix

Constructors

constructor

  • new NonNumericIdentificationKeyValidator(identificationKeyType, length, referenceCharacterSet, requiresCheckCharacterPair?): NonNumericIdentificationKeyValidator

  • Constructor.

    Parameters

    • identificationKeyType: IdentificationKeyType

      Identification key type.

    • length: number

      Length.

    • referenceCharacterSet: CharacterSet

      Reference character set.

    • requiresCheckCharacterPair: boolean = false

      True if the identification key requires a check character pair.

    Returns NonNumericIdentificationKeyValidator

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

referenceValidator

Methods

Protected StaticvalidatorFor

Protected StaticpadIdentificationKey

  • padIdentificationKey(identificationKey, validation): string

  • Pad an identification key on the left with zeroes 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.

validate

  • validate(identificationKey, validation?): void

  • Validate a non-numeric identification key and throw an exception if validation fails.

    Parameters

    Returns void

ProtectedvalidatePrefix

  • validatePrefix(partialIdentificationKey, positionOffset?): 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