Class GTINCreator

GTIN creator. Applicable to GTIN-13, GTIN-12, and GTIN-8 types; no applicable to GTIN-14 type.

Hierarchy

GTINValidator<this> & AbstractNumericIdentificationKeyCreator<this>
- GTINCreator

Properties

leaderType

leaderType: LeaderType

identificationKeyType

identificationKeyType: IdentificationKeyType

prefixType

prefixType: PrefixType

length

length: number

referenceCharacterSet

referenceCharacterSet: CharacterSet

referenceValidator

referenceValidator: CharacterSetValidator

Constructors

constructor

new GTINCreator(prefixManager, gtinType): GTINCreator
Constructor. Called internally by PrefixManager.gtinCreator; should not be called by other code.
Parameters
- prefixManager: PrefixManager
  Prefix manager.
- gtinType: GTINType
  GTIN type.
Returns GTINCreator
Overrides Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).constructor
- Defined in idkey.ts:1320

Accessors

prefix

get prefix(): string
Returns string
Inherit Doc
Overrides Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).prefix
- Defined in idkey.ts:1329

gtinType

get gtinType(): GTINType
Returns GTINType
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).gtinType
- Defined in idkey.ts:529

capacity

get capacity(): number
Returns number
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).capacity
- Defined in idkey.ts:1169

tweak

get tweak(): bigint
Get the tweak for sparse creation.

Returns bigint
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).tweak
- Defined in idkey.ts:1177
set tweak(value): void
Set the tweak for sparse creation.
Parameters
- value: bigint
Returns void
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).tweak
- Defined in idkey.ts:1184

referenceCreator

get referenceCreator(): CharacterSetCreator
Returns CharacterSetCreator
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).referenceCreator
- Defined in idkey.ts:1050

prefixManager

get prefixManager(): PrefixManager
Returns PrefixManager
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).prefixManager
- Defined in idkey.ts:1057

referenceLength

get referenceLength(): number
Returns number
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).referenceLength
- Defined in idkey.ts:1073

Methods

`Static`zeroSuppress

zeroSuppress(gtin12): string
Zero suppress a GTIN-12.
Parameters
- gtin12: string
  GTIN-12.
Returns string
Zero-suppressed GTIN-12.
- Defined in idkey.ts:1391

`Static`convertToGTIN14

convertToGTIN14(indicatorDigit, gtin): string
Convert a GTIN of any length to a GTIN-14 with an optional indicator digit.
Parameters
- indicatorDigit: string
  Indicator digit. If blank, assumes "0" if the GTIN is not already a GTIN-14.
- gtin: string
  GTIN.
Returns string
GTIN-14.
- Defined in idkey.ts:1433

`Static`normalize

normalize(gtin): string
Normalize a GTIN of any length.
- A GTIN-14 that starts with six zeros or a GTIN-13 that starts with five zeros is normalized to GTIN-8.
- A GTIN-14 that starts with two zeros or a GTIN-13 that starts with one zero is normalized to GTIN-12.
- A GTIN-14 that starts with one zero is normalized to GTIN-13.
- Otherwise, the GTIN is unchanged.
Parameters
- gtin: string
  GTIN.
Returns string
Normalized GTIN.
- Defined in idkey.ts:1466

`Static`zeroExpand

zeroExpand(zeroSuppressedGTIN12): string
Zero expand a zero-suppressed GTIN-12.
Parameters
- zeroSuppressedGTIN12: string
  Zero-suppressed GTIN-12.
Returns string
GTIN-12.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).zeroExpand
- Defined in idkey.ts:551

`Static`validateAny

validateAny(gtin, gtinLevel?): void
Validate any GTIN, optionally against a level.
Parameters
- gtin: string
  GTIN.
- gtinLevel: GTINLevel = GTINLevel.Any
  Level at which GTIN is to be validated.
Returns void
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).validateAny
- Defined in idkey.ts:593

`Static`validateGTIN14

validateGTIN14(gtin14): void
Validate a GTIN-14.
Parameters
- gtin14: string
  GTIN-14.
Returns void
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).validateGTIN14
- Defined in idkey.ts:666

`Protected` `Static`validatorFor

validatorFor(characterSet): CharacterSetValidator
Get the character set validator for a character set.
Parameters
- characterSet: CharacterSet
  Character set.
Returns CharacterSetValidator
Character set validator.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).validatorFor
- Defined in idkey.ts:222

`Protected` `Static`padIdentificationKey

padIdentificationKey(identificationKey, validation): string
Pad an identification key on the left with zeroes for validation purposes. This is done to align an identification key with a position offset for any error message that may be thrown by the reference validator.
Parameters
- identificationKey: string
  Identification key.
- validation: undefined | IdentificationKeyValidation
  Identification key validation parameters.
Returns string
Padded identification key.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).padIdentificationKey
- Defined in idkey.ts:313

createGTIN14

createGTIN14(indicatorDigit, value, sparse?): string
Create a GTIN-14 with an indicator digit and a reference based on a numeric value. The value is converted to a reference of the appropriate length using NUMERIC_CREATOR.
Parameters
- indicatorDigit: string
  Indicator digit.
- value: number | bigint
  Numeric value of the reference.
- Optionalsparse: boolean
  If true, the value is mapped to a sparse sequence resistant to discovery. Default is false.
Returns string
GTIN-14.
- Defined in idkey.ts:1349
createGTIN14(indicatorDigit, values, sparse?): IterableIterator<string, any, any>
Create multiple GTIN-14s with an indicator digit and references based on numeric values. The values are converted to references of the appropriate length using NUMERIC_CREATOR.

The implementation uses CharacterSetCreator.create, so the values are created only as needed.
Parameters
- indicatorDigit: string
  Indicator digit.
- values: Iterable<number | bigint, any, any>
  Values.
- Optionalsparse: boolean
  If true, the values are mapped to a sparse sequence resistant to discovery. Default is false.
Returns IterableIterator<string, any, any>
Iterable iterator over created GTIN-14s.
- Defined in idkey.ts:1369

`Protected`validatePrefix

validatePrefix(partialIdentificationKey, positionOffset?): void
Parameters
- partialIdentificationKey: string
- OptionalpositionOffset: number
Returns void
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).validatePrefix
- Defined in idkey.ts:537

validate

validate(identificationKey, validation?): void
Parameters
- identificationKey: string
- Optionalvalidation: IdentificationKeyValidation
Returns void
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).validate
- Defined in idkey.ts:412

`Protected`init

init(prefixManager, prefix): void
Initialize the prefix manager. This method is in lieu of a constructor due to the mixin architecture.
Parameters
- prefixManager: PrefixManager
  Prefix manager.
- prefix: string
  Prefix within prefix manager to use to calculate reference length.
Returns void
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).init
- Defined in idkey.ts:1157

create

create(value, sparse?): string
Parameters
- value: number | bigint
- Optionalsparse: boolean
Returns string
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).create
- Defined in idkey.ts:1206
create(values, sparse?): IterableIterator<string, any, any>
Parameters
- values: Iterable<number | bigint, any, any>
- Optionalsparse: boolean
Returns IterableIterator<string, any, any>
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).create
- Defined in idkey.ts:1211

createAll

createAll(): IterableIterator<string, any, any>
Returns IterableIterator<string, any, any>
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).createAll
- Defined in idkey.ts:1273

Class GTINCreator

Hierarchy

Index

Properties

Constructors

Accessors

Methods

Properties

leaderType

identificationKeyType

prefixType

length

referenceCharacterSet

referenceValidator

Constructors

constructor

Parameters

Returns GTINCreator

Accessors

prefix

Returns string

Inherit Doc

gtinType

Returns GTINType

Inherit Doc

capacity

Returns number

Inherit Doc

tweak

Returns bigint

Parameters

Returns void

referenceCreator

Returns CharacterSetCreator

Inherit Doc

prefixManager

Returns PrefixManager

Inherit Doc

referenceLength

Returns number

Inherit Doc

Methods

StaticzeroSuppress

Parameters

Returns string

StaticconvertToGTIN14

Parameters

Returns string

Staticnormalize

Parameters

Returns string

StaticzeroExpand

Parameters

Returns string

StaticvalidateAny

Parameters

Returns void

StaticvalidateGTIN14

Parameters

Returns void

Protected StaticvalidatorFor

Parameters

Returns CharacterSetValidator

Protected StaticpadIdentificationKey

Parameters

Returns string

createGTIN14

Parameters

Returns string

Parameters

Returns IterableIterator<string, any, any>

ProtectedvalidatePrefix

Parameters

Returns void

Inherit Doc

validate

Parameters

Returns void

Protectedinit

Parameters

`Static`zeroSuppress

`Static`convertToGTIN14

`Static`normalize

`Static`zeroExpand

`Static`validateAny

`Static`validateGTIN14

`Protected` `Static`validatorFor

`Protected` `Static`padIdentificationKey

`Protected`validatePrefix

`Protected`init