Class GTINValidator

GTIN validator.

Hierarchy

AbstractNumericIdentificationKeyValidator
- GTINValidator

Index

Constructors

constructor

new GTINValidator(gtinType): GTINValidator
Constructor.
Parameters
- gtinType: GTINType
  GTIN type.
Returns GTINValidator
Overrides AbstractNumericIdentificationKeyValidator.constructor
- Defined in idkey.ts:501

Accessors

gtinType

get gtinType(): GTINType
Returns GTINType
Inherit Doc
- Defined in idkey.ts:529

leaderType

get leaderType(): LeaderType
Returns LeaderType
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.leaderType
- Defined in idkey.ts:405

identificationKeyType

get identificationKeyType(): IdentificationKeyType
Returns IdentificationKeyType
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.identificationKeyType
- Defined in idkey.ts:268

prefixType

get prefixType(): PrefixType
Returns PrefixType
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.prefixType
- Defined in idkey.ts:275

length

get length(): number
Returns number
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.length
- Defined in idkey.ts:282

referenceCharacterSet

get referenceCharacterSet(): CharacterSet
Returns CharacterSet
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.referenceCharacterSet
- Defined in idkey.ts:289

referenceValidator

get referenceValidator(): CharacterSetValidator
Returns CharacterSetValidator
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.referenceValidator
- Defined in idkey.ts:296

Methods

`Static`zeroExpand

zeroExpand(zeroSuppressedGTIN12): string
Zero expand a zero-suppressed GTIN-12.
Parameters
- zeroSuppressedGTIN12: string
  Zero-suppressed GTIN-12.
Returns string
GTIN-12.
- Defined in idkey.ts:551

`Static`validateAny

validateAny(gtin, 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
- Defined in idkey.ts:593

`Static`validateGTIN14

validateGTIN14(gtin14): void
Validate a GTIN-14.
Parameters
- gtin14: string
  GTIN-14.
Returns void
- Defined in idkey.ts:666

`Protected` `Static`validatorFor

validatorFor(characterSet): CharacterSetValidator
Get the character set validator for a character set.
Parameters
- characterSet: CharacterSet
  Character set.
Returns CharacterSetValidator
Character set validator.
Inherited from AbstractNumericIdentificationKeyValidator.validatorFor
- Defined in idkey.ts:222

`Protected` `Static`padIdentificationKey

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.
Inherited from AbstractNumericIdentificationKeyValidator.padIdentificationKey
- Defined in idkey.ts:313

`Protected`validatePrefix

validatePrefix(partialIdentificationKey, positionOffset?): void
Parameters
- partialIdentificationKey: string
- OptionalpositionOffset: number
Returns void
Inherit Doc
Overrides AbstractNumericIdentificationKeyValidator.validatePrefix
- Defined in idkey.ts:537

validate

validate(identificationKey, validation?): void
Parameters
- identificationKey: string
- Optionalvalidation: IdentificationKeyValidation
Returns void
Inherit Doc
Inherited from AbstractNumericIdentificationKeyValidator.validate
- Defined in idkey.ts:412

Class GTINValidator

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GTINValidator

Accessors

gtinType

Returns GTINType

Inherit Doc

leaderType

Returns LeaderType

Inherit Doc

identificationKeyType

Returns IdentificationKeyType

Inherit Doc

prefixType

Returns PrefixType

Inherit Doc

length

Returns number

Inherit Doc

referenceCharacterSet

Returns CharacterSet

Inherit Doc

referenceValidator

Returns CharacterSetValidator

Inherit Doc

Methods

StaticzeroExpand

Parameters

Returns string

StaticvalidateAny

Parameters

Returns void

StaticvalidateGTIN14

Parameters

Returns void

Protected StaticvalidatorFor

Parameters

Returns CharacterSetValidator

Protected StaticpadIdentificationKey

Parameters

Returns string

ProtectedvalidatePrefix

Parameters

Returns void

Inherit Doc

validate

Parameters

Returns void

Inherit Doc

Settings

On This Page

`Static`zeroExpand

`Static`validateAny

`Static`validateGTIN14

`Protected` `Static`validatorFor

`Protected` `Static`padIdentificationKey

`Protected`validatePrefix