AIDC Toolkit / GS1 / PrefixValidator

Variable: PrefixValidator

const PrefixValidator: object

Defined in: src/prefix-validator.ts:105

Prefix validator.

Type Declaration

GS1_COMPANY_PREFIX_MINIMUM_LENGTH

GS1_COMPANY_PREFIX_MINIMUM_LENGTH: 4

GS1 Company Prefix minimum length.

GS1_COMPANY_PREFIX_MAXIMUM_LENGTH

GS1_COMPANY_PREFIX_MAXIMUM_LENGTH: 12

GS1 Company Prefix maximum length.

UPC_COMPANY_PREFIX_MINIMUM_LENGTH

UPC_COMPANY_PREFIX_MINIMUM_LENGTH: 5

U.P.C. Company Prefix minimum length.

UPC_COMPANY_PREFIX_MAXIMUM_LENGTH

UPC_COMPANY_PREFIX_MAXIMUM_LENGTH: 11

U.P.C. Company Prefix maximum length.

GS1_8_PREFIX_MINIMUM_LENGTH

GS1_8_PREFIX_MINIMUM_LENGTH: 2

GS1-8 Prefix minimum length.

GS1_8_PREFIX_MAXIMUM_LENGTH

GS1_8_PREFIX_MAXIMUM_LENGTH: 7

GS1-8 Prefix maximum length.

validate()

readonly validate(prefixType, allowUPCCompanyPrefix, allowGS18Prefix, prefix, isFromIdentifier, isNumericIdentifier, errorMessageParseKey?): void

Validate a prefix.

Parameters

prefixType

PrefixType

Prefix type.

allowUPCCompanyPrefix

boolean

If true, a U.P.C. Company Prefix expressed as a GS1 Company Prefix is permitted.

allowGS18Prefix

boolean

If true, a GS1-8 Prefix expressed as a GS1 Company Prefix is permitted.

prefix

string

Prefix.

isFromIdentifier

boolean = false

If true, the prefix is from an identifier and should be trimmed before its character set is validated.

isNumericIdentifier

boolean = false

If true, the prefix is from a numeric identifier and its character set will be validated by the caller.

errorMessageParseKey?

Parse key for error message when validating GS1 Company Prefix type.

"Check.lengthOfStringForPriceOrWeightMustBeExactly" | "Check.priceOrWeightComponent" | "Check.lengthOfStringForCheckCharacterPairMustBeLessThanOrEqualTo" | "Identifier.reference" | "Identifier.identifierTypeLength" | "Identifier.invalidCheckDigit" | "Identifier.invalidGTINLength" | "Identifier.invalidGTIN14Length" | "Identifier.invalidZeroSuppressedGTIN12" | "Identifier.invalidZeroSuppressibleGTIN12" | "Identifier.invalidZeroSuppressedGTIN12AsGTIN13" | "Identifier.invalidZeroSuppressedGTIN12AsGTIN14" | "Identifier.invalidGTINAtRetail" | "Identifier.invalidGTINAtOtherThanRetail" | "Identifier.invalidRCNLength" | "Identifier.invalidVariableMeasureRCNFormat" | "Identifier.invalidVariableMeasureRCNPrefix" | "Identifier.invalidVariableMeasurePriceOrWeight" | "Identifier.indicatorDigit" | "Identifier.serialComponent" | "Identifier.referenceCantBeAllNumeric" | "Identifier.invalidCheckCharacterPair" | "Prefix.gs1CompanyPrefix" | "Prefix.upcCompanyPrefix" | "Prefix.gs18Prefix" | "Prefix.gs1CompanyPrefixCantStartWith0" | "Prefix.gs1CompanyPrefixCantStartWith00000" | "Prefix.gs1CompanyPrefixCantStartWith000000" | "Prefix.upcCompanyPrefixCantStartWith0000" | "Prefix.gs18PrefixCantStartWith0" | "Prefix.identifierTypeNotSupportedByGS18Prefix" | "Prefix.gs1CompanyPrefixLengthDataHTTPError" | "Prefix.gs1CompanyPrefixLengthDataNotLoaded"

Returns

void

normalize()

readonly normalize(prefixType, prefix): PrefixProvider

Normalize a prefix.

Parameters

prefixType

PrefixType

Prefix type.

prefix

string

Prefix.

Returns

PrefixProvider

Prefix provider with normalized prefix type and prefix.