Interface IdentificationKeyCreator

Identification key creator. Creates an identification key based on its definition in section 3 of the GS1 General Specifications.

Keys are created based on a prefix defined in a prefix manager to which the identification key creator is bound.

interface IdentificationKeyCreator {
    get prefixManager(): PrefixManager;
    get prefix(): string;
    get referenceLength(): number;
    get identificationKeyType(): IdentificationKeyType;
    get prefixType(): PrefixType;
    get length(): number;
    get referenceCharacterSet(): ContentCharacterSet;
    get referenceCreator(): CharacterSetCreator;
    validate: (
        identificationKey: string,
        validation?: IdentificationKeyValidation,
    ) => void;
}

Hierarchy (View Summary)

Properties

validate

Accessors

prefixManager prefix referenceLength identificationKeyType prefixType length referenceCharacterSet referenceCreator

Properties

validate

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

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

Type declaration

Accessors

prefixManager

prefix

referenceLength

  • get referenceLength(): number

  • Get the reference length.

    Returns number

identificationKeyType

  • get identificationKeyType(): IdentificationKeyType

  • Get the identification key type. Per the GS1 General Specifications, the identification key type determines the remaining properties.

    Returns IdentificationKeyType

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

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

referenceCharacterSet

referenceCreator

Settings

Member Visibility

On This Page

Properties
Accessors