AIDC Toolkit

Appearance

AIDC Toolkit / GS1 / IdentifierValidator

Abstract Class: IdentifierValidator<TIdentifierType, TIdentifierValidation> ​

Defined in: src/identifier-validator.ts:27

Identifier validator. Validates an identifier against its definition in section 3 of the GS1 General Specifications. Implements common functionality for an identifier validator.

Extended by ​

Type Parameters ​

TIdentifierType ​

TIdentifierType extends IdentifierType = IdentifierType

Identifier type type.

TIdentifierValidation ​

TIdentifierValidation extends IdentifierValidation = IdentifierValidation

Identifier validation type.

Implements ​

Constructors ​

Constructor ​

protected new IdentifierValidator<TIdentifierType, TIdentifierValidation>(identifierDescriptor): IdentifierValidator<TIdentifierType, TIdentifierValidation>

Defined in: src/identifier-validator.ts:54

Constructor.

Parameters ​

identifierDescriptor ​

IdentifierTypeDescriptor<TIdentifierType>

Identifier descriptor.

Returns ​

IdentifierValidator<TIdentifierType, TIdentifierValidation>

Accessors ​

identifierType ​

Get Signature ​

get identifierType(): IdentifierTypeDescriptor<TIdentifierType>["identifierType"]

Defined in: src/identifier-validator.ts:65

Get the identifier type. Per the GS1 General Specifications, the identifier type determines the remaining properties.

Returns ​

IdentifierTypeDescriptor<TIdentifierType>["identifierType"]

Identifier type. Per the GS1 General Specifications, the identifier type determines the remaining properties.

Implementation of ​

IdentifierDescriptor.identifierType

prefixType ​

Get Signature ​

get prefixType(): IdentifierTypeDescriptor<TIdentifierType>["prefixType"]

Defined in: src/identifier-validator.ts:73

Get the prefix type supported by the identifier type. For all identifier types except the GTIN, this is a GS1 Company Prefix. For the GTIN, the prefix type determines the length.

Returns ​

IdentifierTypeDescriptor<TIdentifierType>["prefixType"]

Prefix type supported by the identifier type. For all identifier types except the GTIN, this is a GS1 Company Prefix. For the GTIN, the prefix type determines the length.

Implementation of ​

IdentifierDescriptor.prefixType

length ​

Get Signature ​

get length(): IdentifierTypeDescriptor<TIdentifierType>["length"]

Defined in: src/identifier-validator.ts:82

Get the length. For numeric identifier types, the length is fixed; for alphanumeric identifier types, the length is the maximum.

Returns ​

IdentifierTypeDescriptor<TIdentifierType>["length"]

Length. For numeric identifier types, the length is fixed; for non-numeric identifier types, the length is the maximum.

Implementation of ​

IdentifierDescriptor.length

referenceCharacterSet ​

Get Signature ​

get referenceCharacterSet(): IdentifierTypeDescriptor<TIdentifierType>["referenceCharacterSet"]

Defined in: src/identifier-validator.ts:89

Get the reference character set.

Returns ​

IdentifierTypeDescriptor<TIdentifierType>["referenceCharacterSet"]

Reference character set.

Implementation of ​

IdentifierDescriptor.referenceCharacterSet

referenceCreator ​

Get Signature ​

get referenceCreator(): CharacterSetCreator

Defined in: src/identifier-validator.ts:96

Get the reference creator.

Returns ​

CharacterSetCreator

Methods ​

padIdentifier() ​

protected padIdentifier(identifier, positionOffset?): string

Defined in: src/identifier-validator.ts:113

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

Parameters ​

identifier ​

string

Identifier.

positionOffset? ​

number

Position offset within a larger string.

Returns ​

string

Padded identifier.

validatePrefix() ​

protected validatePrefix(partialIdentifier): void

Defined in: src/identifier-validator.ts:124

Validate the prefix within an identifier.

Parameters ​

partialIdentifier ​

string

Partial identifier.

Returns ​

void

validate() ​

abstract validate(identifier, validation?): void

Defined in: src/identifier-validator.ts:138

Validate an identifier and throw an error if validation fails.

Parameters ​

identifier ​

string

Identifier.

validation? ​

TIdentifierValidation

Identifier validation parameters.

Returns ​

void

Implementation of ​

StringValidator.validate