Class GTINValidator

GTIN validator.

Hierarchy

  • AbstractNumericIdentificationKeyValidator
    • GTINValidator

Constructors

constructor

Accessors

gtinType leaderType identificationKeyType prefixType length referenceCharacterSet referenceCreator

Methods

zeroSuppress zeroExpand convertToGTIN14 normalize validateAny validateGTIN14 creatorFor validatePrefix validate padIdentificationKey

Constructors

constructor

Accessors

gtinType

leaderType

identificationKeyType

prefixType

length

  • get length(): number

  • Returns number

    Inherit Doc

referenceCharacterSet

referenceCreator

Methods

StaticzeroSuppress

  • zeroSuppress(gtin12: string): string

  • Zero suppress a GTIN-12.

    Parameters

    • gtin12: string

      GTIN-12.

    Returns string

    Zero-suppressed GTIN-12.

StaticzeroExpand

  • zeroExpand(zeroSuppressedGTIN12: string): string

  • Zero expand a zero-suppressed GTIN-12.

    Parameters

    • zeroSuppressedGTIN12: string

      Zero-suppressed GTIN-12.

    Returns string

    GTIN-12.

StaticconvertToGTIN14

  • convertToGTIN14(indicatorDigit: string, gtin: string): string

  • Convert a GTIN of any length to a GTIN-14 with an optional indicator digit.

    Parameters

    • indicatorDigit: string

      Indicator digit. If blank, assumes "0" if the GTIN is not already a GTIN-14.

    • gtin: string

      GTIN.

    Returns string

    GTIN-14.

Staticnormalize

  • normalize(gtin: string): string

  • Normalize a GTIN of any length.

    • A GTIN-14 that starts with six zeros or a GTIN-13 that starts with five zeros is normalized to GTIN-8.
    • A GTIN-14 that starts with two zeros or a GTIN-13 that starts with one zero is normalized to GTIN-12.
    • A GTIN-14 that starts with one zero is normalized to GTIN-13.
    • Otherwise, the GTIN is unchanged.

    Parameters

    • gtin: string

      GTIN.

    Returns string

    Normalized GTIN.

StaticvalidateAny

  • validateAny(gtin: string, gtinLevel?: GTINLevel): void

  • Validate any GTIN, optionally against a level.

    Parameters

    • gtin: string

      GTIN.

    • gtinLevel: GTINLevel = GTINLevel.Any

      Level at which GTIN is to be validated.

    Returns void

StaticvalidateGTIN14

  • validateGTIN14(gtin14: string): void

  • Validate a GTIN-14.

    Parameters

    • gtin14: string

      GTIN-14.

    Returns void

Protected StaticcreatorFor

ProtectedvalidatePrefix

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

  • Parameters

    • partialIdentificationKey: string
    • OptionalpositionOffset: number

    Returns void

    Inherit Doc

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.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods