AIDC Toolkit / GS1 / NonNumericIdentifierCreator
Class: NonNumericIdentifierCreator ​
Defined in: src/non-numeric-identifier-creator.ts:21
Non-numeric identifier creator.
Extends ​
NonNumericIdentifierValidator<this> &IdentifierCreator<NonNumericIdentifierType,NonNumericIdentifierValidation,this>
Constructors ​
Constructor ​
new NonNumericIdentifierCreator(
prefixProvider,identifierType):NonNumericIdentifierCreator
Defined in: src/non-numeric-identifier-creator.ts:39
Constructor.
Parameters ​
prefixProvider ​
Prefix provider.
identifierType ​
Identifier type.
Returns ​
NonNumericIdentifierCreator
Overrides ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).constructor
Accessors ​
referenceValidation ​
Get Signature ​
get
protectedreferenceValidation():CharacterSetValidation
Defined in: src/non-numeric-identifier-creator.ts:53
Get the reference validation parameters.
Returns ​
requiresCheckCharacterPair ​
Get Signature ​
get requiresCheckCharacterPair():
boolean
Defined in: src/non-numeric-identifier-validator.ts:57
Determine if the identifier requires a check character pair.
Returns ​
boolean
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).requiresCheckCharacterPair
identifierType ​
Get Signature ​
get identifierType():
IdentifierTypeDescriptor<TIdentifierType>["identifierType"]
Defined in: src/identifier-validator.ts:65
Get the identifier type. Per the GS1 General Specifications, the identifier type determines the remaining properties.
Returns ​
IdentifierTypeDescriptor<TIdentifierType>["identifierType"]
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).identifierType
prefixType ​
Get Signature ​
get prefixType():
IdentifierTypeDescriptor<TIdentifierType>["prefixType"]
Defined in: src/identifier-validator.ts:73
Get the prefix type supported by the identifier type. For all identifier types except the GTIN, this is a GS1 Company Prefix. For the GTIN, the prefix type determines the length.
Returns ​
IdentifierTypeDescriptor<TIdentifierType>["prefixType"]
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).prefixType
length ​
Get Signature ​
get length():
IdentifierTypeDescriptor<TIdentifierType>["length"]
Defined in: src/identifier-validator.ts:82
Get the length. For numeric identifier types, the length is fixed; for alphanumeric identifier types, the length is the maximum.
Returns ​
IdentifierTypeDescriptor<TIdentifierType>["length"]
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).length
referenceCharacterSet ​
Get Signature ​
get referenceCharacterSet():
IdentifierTypeDescriptor<TIdentifierType>["referenceCharacterSet"]
Defined in: src/identifier-validator.ts:89
Get the reference character set.
Returns ​
IdentifierTypeDescriptor<TIdentifierType>["referenceCharacterSet"]
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).referenceCharacterSet
referenceCreator ​
Get Signature ​
get referenceCreator():
CharacterSetCreator
Defined in: src/identifier-validator.ts:96
Get the reference creator.
Returns ​
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).referenceCreator
prefixProvider ​
Get Signature ​
get prefixProvider():
PrefixProvider
Defined in: src/identifier-creator.ts:21
Get the prefix provider to which this identifier creator is bound.
Returns ​
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).prefixProvider
prefix ​
Get Signature ​
get prefix():
string
Defined in: src/identifier-creator.ts:27
Get the prefix, equivalent to calling prefixProvider.prefix for a GTIN or prefixProvider.gs1CompanyPrefix for all other identifier types.
Returns ​
string
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).prefix
referenceLength ​
Get Signature ​
get referenceLength():
number
Defined in: src/identifier-creator.ts:32
Get the reference length.
Returns ​
number
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).referenceLength
Methods ​
create() ​
create<
TTransformerInput>(referenceOrReferences):TransformerOutput<TTransformerInput,string>
Defined in: src/non-numeric-identifier-creator.ts:69
Create identifier(s) with reference(s).
Type Parameters ​
TTransformerInput ​
TTransformerInput extends TransformerInput<string>
Transformer input type.
Parameters ​
referenceOrReferences ​
TTransformerInput
Reference(s).
Returns ​
TransformerOutput<TTransformerInput, string>
Identifier(s).
validate() ​
validate(
identifier,validation?):void
Defined in: src/non-numeric-identifier-validator.ts:70
Validate a non-numeric identifier and throw an error if validation fails.
Parameters ​
identifier ​
string
Identifier.
validation? ​
NonNumericIdentifierValidation
Validation parameters.
Returns ​
void
Inherited from ​
NonNumericIdentifierValidator.validate
padIdentifier() ​
protectedpadIdentifier(identifier,positionOffset?):string
Defined in: src/identifier-validator.ts:113
Pad an identifier on the left with zero-value character for validation purposes. This is done to align an identifier with a position offset for any error message that may be thrown by the reference validator.
Parameters ​
identifier ​
string
Identifier.
positionOffset? ​
number
Position offset within a larger string.
Returns ​
string
Padded identifier.
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).padIdentifier
validatePrefix() ​
protectedvalidatePrefix(partialIdentifier):void
Defined in: src/identifier-validator.ts:124
Validate the prefix within an identifier.
Parameters ​
partialIdentifier ​
string
Partial identifier.
Returns ​
void
Inherited from ​
MixinAbstractIdentifierCreator< NonNumericIdentifierType, NonNumericIdentifierValidation >(NonNumericIdentifierValidator).validatePrefix