Class NonGTINNumericIdentificationKeyCreator

Non-GTIN numeric identification key creator.

Hierarchy

NonGTINNumericIdentificationKeyValidator<this> & AbstractNumericIdentificationKeyCreator<
this,
>
- NonGTINNumericIdentificationKeyCreator

Index

Properties

leaderType

leaderType: LeaderType

identificationKeyType

identificationKeyType: IdentificationKeyType

prefixType

prefixType: PrefixType

length

length: number

referenceCharacterSet

referenceCharacterSet: ContentCharacterSet

referenceCreator

referenceCreator: CharacterSetCreator

Constructors

constructor

new NonGTINNumericIdentificationKeyCreator(
    prefixManager: PrefixManager,
    identificationKeyType: IdentificationKeyType,
    length: number,
    leaderType?: LeaderType,
): NonGTINNumericIdentificationKeyCreator
Constructor. Called internally by PrefixManager non-GTIN numeric identification key creator getters; should not be called by other code.
Parameters
- prefixManager: PrefixManager
  Prefix manager.
- identificationKeyType: IdentificationKeyType
  Identification key type.
- length: number
  Length.
- leaderType: LeaderType = LeaderType.None
  Leader type.
Returns NonGTINNumericIdentificationKeyCreator
Overrides Mixin(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).constructor
- Defined in idkey.ts:1451

Accessors

capacity

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

tweak

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

Returns bigint
Inherited from Mixin(NonGTINNumericIdentificationKeyValidator, 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(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).tweak
- Defined in idkey.ts:1270

prefixManager

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

prefix

get prefix(): string
Returns string
Inherit Doc
Inherited from Mixin(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).prefix
- Defined in idkey.ts:1170

referenceLength

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

Methods

`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(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).creatorFor
- Defined in idkey.ts:228

validate

validate(
identificationKey: string,
validation?: IdentificationKeyValidation,
): void
Parameters
- identificationKey: string
- Optionalvalidation: IdentificationKeyValidation
Returns void
Inherited from Mixin(NonGTINNumericIdentificationKeyValidator, 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(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).padIdentificationKey
- Defined in idkey.ts:303

`Protected`validatePrefix

validatePrefix(partialIdentificationKey: string, positionOffset?: number): void
Validate the prefix within an identification key.
Parameters
- partialIdentificationKey: string
  Partial identification key.
- OptionalpositionOffset: number
  Position offset within a larger string.
Returns void
Inherited from Mixin(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).validatePrefix
- Defined in idkey.ts:317

`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(NonGTINNumericIdentificationKeyValidator, 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(NonGTINNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).create
- Defined in idkey.ts:1292

createAll

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

Class NonGTINNumericIdentificationKeyCreator

Hierarchy

Index

Properties

Constructors

Accessors

Methods

Properties

leaderType

identificationKeyType

prefixType

length

referenceCharacterSet

referenceCreator

Constructors

constructor

Parameters

Returns NonGTINNumericIdentificationKeyCreator

Accessors

capacity

Returns number

Inherit Doc

tweak

Returns bigint

Parameters

Returns void

prefixManager

Returns PrefixManager

Inherit Doc

prefix

Returns string

Inherit Doc

referenceLength

Returns number

Inherit Doc

Methods

Protected StaticcreatorFor

Parameters

Returns CharacterSetCreator

validate

Parameters

Returns void

ProtectedpadIdentificationKey

Parameters

Returns string

ProtectedvalidatePrefix

Parameters

Returns void

Protectedinit

Parameters

Returns void

create

Type Parameters

Parameters

Returns TransformerOutput<TTransformerInput, string>

Inherit Doc

createAll

Returns Iterable<string>

Inherit Doc

Settings

On This Page

`Protected` `Static`creatorFor

`Protected`padIdentificationKey

`Protected`validatePrefix

`Protected`init