Interface IdentificationKeyValidator<V>

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

interface IdentificationKeyValidator<V> {
    get identificationKeyType(): IdentificationKeyType;
    get prefixType(): PrefixType;
    get length(): number;
    get referenceCharacterSet(): CharacterSet;
    get referenceValidator(): CharacterSetValidator;
    validate: ((identificationKey: string, validation?: V) => void);
}

Type Parameters

V extends IdentificationKeyValidation = IdentificationKeyValidation

Hierarchy (view full)

StringValidator<V>
- IdentificationKeyValidator
  - NumericIdentificationKeyValidator
  - IdentificationKeyCreator

Index

Properties

Accessors

identificationKeyType prefixType length referenceCharacterSet referenceValidator

Properties

validate

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

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

Type declaration

- (identificationKey, validation?): void
- Parameters
  - identificationKey: string
    Identification key.
  - Optionalvalidation: V
    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:148

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:154

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:160

referenceCharacterSet

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

Returns CharacterSet
- Defined in idkey.ts:165

referenceValidator

get referenceValidator(): CharacterSetValidator
Get the reference validator.

Returns CharacterSetValidator
- Defined in idkey.ts:170