Interface IdentificationKeyValidator<TIdentificationKeyValidation>

Identification key validator. Validates an identification key against its definition in section 3 of the GS1 General Specifications.

interface IdentificationKeyValidator<
    TIdentificationKeyValidation extends
        IdentificationKeyValidation = IdentificationKeyValidation,
> {
    get identificationKeyType(): IdentificationKeyType;
    get prefixType(): PrefixType;
    get length(): number;
    get referenceCharacterSet(): ContentCharacterSet;
    get referenceCreator(): CharacterSetCreator;
    validate: (
        identificationKey: string,
        validation?: TIdentificationKeyValidation,
    ) => void;
}

Type Parameters

TIdentificationKeyValidation extends IdentificationKeyValidation = IdentificationKeyValidation

Hierarchy (View Summary)

StringValidator<TIdentificationKeyValidation>
- IdentificationKeyValidator
  - NumericIdentificationKeyValidator
  - IdentificationKeyCreator

Index

Properties

Accessors

identificationKeyType prefixType length referenceCharacterSet referenceCreator

Properties

validate

validate: (
identificationKey: string,
validation?: TIdentificationKeyValidation,
) => void

Validate an identification key and throw an error if validation fails.

Type declaration

- (identificationKey: string, validation?: TIdentificationKeyValidation): void
- Parameters
  - identificationKey: string
    Identification key.
  - Optionalvalidation: TIdentificationKeyValidation
    Identification key validation parameters.
  Returns void

Accessors

identificationKeyType

get identificationKeyType(): IdentificationKeyType
Get the identification key type. Per the GS1 General Specifications, the identification key type determines the remaining properties.

Returns IdentificationKeyType
- Defined in idkey.ts:150

prefixType

get prefixType(): PrefixType
Get the prefix type supported by the identification key type. For all identification key types except the GTIN, this is PrefixType.GS1CompanyPrefix. For the GTIN, the prefix type determines the length.

Returns PrefixType
- Defined in idkey.ts:156

length

get length(): number
Get the length. For numeric identification key types, the length is fixed; for alphanumeric identification key types, the length is the maximum.

Returns number
- Defined in idkey.ts:162

referenceCharacterSet

get referenceCharacterSet(): ContentCharacterSet
Get the reference character set.

Returns ContentCharacterSet
- Defined in idkey.ts:167

referenceCreator

get referenceCreator(): CharacterSetCreator
Get the reference validator.

Returns CharacterSetCreator
- Defined in idkey.ts:172