Class NonNumericIdentificationKeyCreator

Non-numeric identification key creator.

Hierarchy

NonNumericIdentificationKeyValidator<this> & AbstractIdentificationKeyCreator<
this,
>
- NonNumericIdentificationKeyCreator

Index

Properties

identificationKeyType

identificationKeyType: IdentificationKeyType

prefixType

prefixType: PrefixType

length

length: number

referenceCharacterSet

referenceCharacterSet: ContentCharacterSet

referenceCreator

referenceCreator: CharacterSetCreator

Constructors

constructor

new NonNumericIdentificationKeyCreator(
    prefixManager: PrefixManager,
    identificationKeyType: IdentificationKeyType,
    length: number,
    referenceCharacterSet: ContentCharacterSet,
    requiresCheckCharacterPair?: boolean,
): NonNumericIdentificationKeyCreator
Constructor. Called internally by PrefixManager non-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.
- referenceCharacterSet: ContentCharacterSet
  Reference character set.
- requiresCheckCharacterPair: boolean = false
  True if the identification key requires a check character pair.
Returns NonNumericIdentificationKeyCreator
Overrides Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).constructor
- Defined in idkey.ts:1598

Accessors

`Protected`referenceValidation

get referenceValidation(): CharacterSetValidation
Get the reference validation parameters.

Returns CharacterSetValidation
- Defined in idkey.ts:1614

requiresCheckCharacterPair

get requiresCheckCharacterPair(): boolean
Determine if the identification key requires a check character pair.

Returns boolean
Inherited from Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).requiresCheckCharacterPair
- Defined in idkey.ts:979

prefixManager

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

prefix

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

referenceLength

get referenceLength(): number
Returns number
Inherit Doc
Inherited from Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).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(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).creatorFor
- Defined in idkey.ts:228

create

create<TTransformerInput extends TransformerInput<string>>(
referenceOrReferences: TTransformerInput,
): TransformerOutput<TTransformerInput, string>
Create identification key(s) with reference(s).
Type Parameters
- TTransformerInput extends TransformerInput<string>
Parameters
- referenceOrReferences: TTransformerInput
  Reference(s).
Returns TransformerOutput<TTransformerInput, string>
Identification key(s).
- Defined in idkey.ts:1627

validate

validate(
identificationKey: string,
validation?: NonNumericIdentificationKeyValidation,
): void
Parameters
- identificationKey: string
- Optionalvalidation: NonNumericIdentificationKeyValidation
Returns void
Inherited from Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).validate
- Defined in idkey.ts:992
validate(
identificationKey: string,
validation?: IdentificationKeyValidation,
): void
Validate an identification key and throw an error if validation fails.
Parameters
- identificationKey: string
  Identification key.
- Optionalvalidation: IdentificationKeyValidation
  Identification key validation parameters.
Returns void
Inherited from Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).validate
- Defined in idkey.ts:1181

`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(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).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(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).validatePrefix
- Defined in idkey.ts:317

`Protected`init

init(prefixManager: PrefixManager, prefix: string, checkAllowance: number): 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.
- checkAllowance: number
  Number of characters to allow for check digit or check character pair.
Returns void
Inherited from Mixin(NonNumericIdentificationKeyValidator, AbstractIdentificationKeyCreator).init
- Defined in idkey.ts:1143

Class NonNumericIdentificationKeyCreator

Hierarchy

Index

Properties

Constructors

Accessors

Methods

Properties

identificationKeyType

prefixType

length

referenceCharacterSet

referenceCreator

Constructors

constructor

Parameters

Returns NonNumericIdentificationKeyCreator

Accessors

ProtectedreferenceValidation

Returns CharacterSetValidation

requiresCheckCharacterPair

Returns boolean

prefixManager

Returns PrefixManager

Inherit Doc

prefix

Returns string

Inherit Doc

referenceLength

Returns number

Inherit Doc

Methods

Protected StaticcreatorFor

Parameters

Returns CharacterSetCreator

create

Type Parameters

Parameters

Returns TransformerOutput<TTransformerInput, string>

validate

Parameters

Returns void

Parameters

Returns void

ProtectedpadIdentificationKey

Parameters

Returns string

ProtectedvalidatePrefix

Parameters

Returns void

Protectedinit

Parameters

Returns void

Settings

On This Page

`Protected`referenceValidation

`Protected` `Static`creatorFor

`Protected`padIdentificationKey

`Protected`validatePrefix

`Protected`init