AIDC Toolkit

Appearance

AIDC Toolkit / GS1 / NumericIdentifierValidator

Abstract Class: NumericIdentifierValidator<TNumericIdentifierType> ​

Defined in: src/numeric-identifier-validator.ts:25

Numeric identifier validator.

Extends ​

Extended by ​

Type Parameters ​

TNumericIdentifierType ​

TNumericIdentifierType extends NumericIdentifierType = NumericIdentifierType

Numeric identifier type type.

Implements ​

Constructors ​

Constructor ​

new NumericIdentifierValidator<TNumericIdentifierType>(identifierDescriptor): NumericIdentifierValidator<TNumericIdentifierType>

Defined in: src/numeric-identifier-validator.ts:42

Constructor.

Parameters ​

identifierDescriptor ​

IdentifierTypeDescriptor<TNumericIdentifierType>

Identifier descriptor.

Returns ​

NumericIdentifierValidator<TNumericIdentifierType>

Overrides ​

IdentifierValidator.constructor

Accessors ​

leaderType ​

Get Signature ​

get leaderType(): IdentifierTypeDescriptor<TNumericIdentifierType>["leaderType"]

Defined in: src/numeric-identifier-validator.ts:52

Leader type.

Returns ​

IdentifierTypeDescriptor<TNumericIdentifierType>["leaderType"]

Leader type.

Implementation of ​

NumericIdentifierDescriptor.leaderType

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 ​

NumericIdentifierDescriptor.identifierType

Inherited from ​

IdentifierValidator.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 ​

NumericIdentifierDescriptor.prefixType

Inherited from ​

IdentifierValidator.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 ​

NumericIdentifierDescriptor.length

Inherited from ​

IdentifierValidator.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 ​

NumericIdentifierDescriptor.referenceCharacterSet

Inherited from ​

IdentifierValidator.referenceCharacterSet

referenceCreator ​

Get Signature ​

get referenceCreator(): CharacterSetCreator

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

Get the reference creator.

Returns ​

CharacterSetCreator

Inherited from ​

IdentifierValidator.referenceCreator

Methods ​

validate() ​

validate(identifier, validation?): void

Defined in: src/numeric-identifier-validator.ts:59

Validate an identifier and throw an error if validation fails.

Parameters ​

identifier ​

string

Identifier.

validation? ​

NumericIdentifierValidation

Identifier validation parameters.

Returns ​

void

Overrides ​

IdentifierValidator.validate

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.

Inherited from ​

IdentifierValidator.padIdentifier

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

Inherited from ​

IdentifierValidator.validatePrefix