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

referenceCreator

referenceCreator: CharacterSetCreator

Constructors

constructor

new GTINCreator(prefixManager: PrefixManager, gtinType: 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:1391

Accessors

prefix

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

gtinType

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

capacity

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

tweak

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

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

prefixManager

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

referenceLength

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

Methods

`Static`zeroSuppress

zeroSuppress(gtin12: string): string
Zero suppress a GTIN-12.
Parameters
- gtin12: string
  GTIN-12.
Returns string
Zero-suppressed GTIN-12.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).zeroSuppress
- Defined in idkey.ts:547

`Static`zeroExpand

zeroExpand(zeroSuppressedGTIN12: string): 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:584

`Static`convertToGTIN14

convertToGTIN14(indicatorDigit: string, gtin: string): 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.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).convertToGTIN14
- Defined in idkey.ts:627

`Static`normalize

normalize(gtin: string): 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.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).normalize
- Defined in idkey.ts:660

`Static`validateAny

validateAny(gtin: string, gtinLevel?: 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:733

`Static`validateGTIN14

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

`Protected` `Static`creatorFor

creatorFor(characterSet: ContentCharacterSet): CharacterSetCreator
Get the character set creator for a character set.
Parameters
- characterSet: ContentCharacterSet
  Character set.
Returns CharacterSetCreator
Character set creator.
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).creatorFor
- Defined in idkey.ts:228

createGTIN14

createGTIN14<TTransformerInput extends TransformerInput<number | bigint>>(
    indicatorDigit: string,
    valueOrValues: TTransformerInput,
    sparse?: boolean,
): TransformerOutput<TTransformerInput, string>
Create GTIN-14(s) with an indicator digit and reference(s) based on numeric value(s). The value(s) is/are converted to reference(s) of the appropriate length using NUMERIC_CREATOR.
Type Parameters
- TTransformerInput extends TransformerInput<number | bigint>
Parameters
- indicatorDigit: string
  Indicator digit.
- valueOrValues: TTransformerInput
  Numeric value(s).
- sparse: boolean = false
  If true, the value(s) is/are mapped to a sparse sequence resistant to discovery. Default is false.
Returns TransformerOutput<TTransformerInput, string>
GTIN-14(s).
- Defined in idkey.ts:1420

`Protected`validatePrefix

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

validate

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

`Protected`padIdentificationKey

padIdentificationKey(
identificationKey: string,
validation: undefined | IdentificationKeyValidation,
): string
Pad an identification key on the left with zero-value character 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:303

`Protected`init

init(prefixManager: PrefixManager, prefix: string): 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:1244

create

create<TTransformerInput extends TransformerInput<number | bigint>>(
valueOrValues: TTransformerInput,
sparse?: boolean,
): TransformerOutput<TTransformerInput, string>
Type Parameters
- TTransformerInput extends TransformerInput<number | bigint>
Parameters
- valueOrValues: TTransformerInput
- sparse: boolean = false
Returns TransformerOutput<TTransformerInput, string>
Inherit Doc
Inherited from Mixin(GTINValidator, AbstractNumericIdentificationKeyCreator).create
- Defined in idkey.ts:1292

createAll

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

Class GTINCreator

Hierarchy

Index

Properties

Constructors

Accessors

Methods

Properties

leaderType

identificationKeyType

prefixType

length

referenceCharacterSet

referenceCreator

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

prefixManager

Returns PrefixManager

Inherit Doc

referenceLength

Returns number

Inherit Doc

Methods

StaticzeroSuppress

Parameters

Returns string

StaticzeroExpand

Parameters

Returns string

StaticconvertToGTIN14

Parameters

Returns string

Staticnormalize

Parameters

Returns string

StaticvalidateAny

Parameters

Returns void

StaticvalidateGTIN14

Parameters

Returns void

Protected StaticcreatorFor

Parameters

Returns CharacterSetCreator

createGTIN14

Type Parameters

Parameters

Returns TransformerOutput<TTransformerInput, string>

ProtectedvalidatePrefix

Parameters

Returns void

Inherit Doc

validate

Parameters

Returns void

ProtectedpadIdentificationKey

Parameters

Returns string

Protectedinit

Parameters

Returns void

create

Type Parameters

Parameters

`Static`zeroSuppress

`Static`zeroExpand

`Static`convertToGTIN14

`Static`normalize

`Static`validateAny

`Static`validateGTIN14

`Protected` `Static`creatorFor

`Protected`validatePrefix

`Protected`padIdentificationKey

`Protected`init