Class SerializableNumericIdentificationKeyCreator

Serializable numeric identification key creator.

Hierarchy

SerializableNumericIdentificationKeyValidator<this> & AbstractNumericIdentificationKeyCreator<
this,
>
- SerializableNumericIdentificationKeyCreator

Properties

leaderType

leaderType: LeaderType

identificationKeyType

identificationKeyType: IdentificationKeyType

prefixType

prefixType: PrefixType

length

length: number

referenceCharacterSet

referenceCharacterSet: ContentCharacterSet

referenceCreator

referenceCreator: CharacterSetCreator

Constructors

constructor

new SerializableNumericIdentificationKeyCreator(
    prefixManager: PrefixManager,
    identificationKeyType: IdentificationKeyType,
    length: number,
    serialComponentLength: number,
    serialComponentCharacterSet: ContentCharacterSet,
): SerializableNumericIdentificationKeyCreator
Constructor. Called internally by PrefixManager serialized 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.
- serialComponentLength: number
  Serial component length.
- serialComponentCharacterSet: ContentCharacterSet
  Serial component character set.
Returns SerializableNumericIdentificationKeyCreator
Overrides Mixin(SerializableNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).constructor
- Defined in idkey.ts:1481

Accessors

serialComponentLength

get serialComponentLength(): number
Get the serial component length.

Returns number
Inherited from Mixin(SerializableNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).serialComponentLength
- Defined in idkey.ts:886

serialComponentCharacterSet

get serialComponentCharacterSet(): ContentCharacterSet
Get the serial component character set.

Returns ContentCharacterSet
Inherited from Mixin(SerializableNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).serialComponentCharacterSet
- Defined in idkey.ts:893

`Protected`serialComponentValidation

get serialComponentValidation(): CharacterSetValidation
Get the serial component validation parameters.

Returns CharacterSetValidation
Inherited from Mixin(SerializableNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).serialComponentValidation
- Defined in idkey.ts:900

serialComponentCreator

get serialComponentCreator(): CharacterSetCreator
Get the serial component creator.

Returns CharacterSetCreator
Inherited from Mixin(SerializableNumericIdentificationKeyValidator, AbstractNumericIdentificationKeyCreator).serialComponentCreator
- Defined in idkey.ts:907

capacity

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

tweak

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

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

prefixManager

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

prefix

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

referenceLength

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

createSerialized

createSerialized<TTransformerInput extends TransformerInput<string>>(
    value: number,
    serialComponentOrComponents: TTransformerInput,
    sparse?: boolean,
): TransformerOutput<TTransformerInput, string>
Create serialized identification key(s) with a reference based on a numeric value concatenated with serial component(s). The value is converted to a reference of the appropriate length using NUMERIC_CREATOR.
Type Parameters
- TTransformerInput extends TransformerInput<string>
Parameters
- value: number
  Numeric value of the reference.
- serialComponentOrComponents: TTransformerInput
  Serial component(s).
- Optionalsparse: boolean
  If true, the value is mapped to a sparse sequence resistant to discovery. Default is false.
Returns TransformerOutput<TTransformerInput, string>
Serialized identification keys.
- Defined in idkey.ts:1547

concatenate

concatenate<TTransformerInput extends TransformerInput<string>>(
baseIdentificationKey: string,
serialComponentOrComponents: TTransformerInput,
): TransformerOutput<TTransformerInput, string>
Concatenate a base identification key with serial component(s).
Type Parameters
- TTransformerInput extends TransformerInput<string>
Parameters
- baseIdentificationKey: string
  Base identification key.
- serialComponentOrComponents: TTransformerInput
  Serial component(s).
Returns TransformerOutput<TTransformerInput, string>
Serialized identification key(s).
- Defined in idkey.ts:1563

validate

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

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

createAll

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

Class SerializableNumericIdentificationKeyCreator

Hierarchy

Index

Properties

Constructors

Accessors

Methods

Properties

leaderType

identificationKeyType

prefixType

length

referenceCharacterSet

referenceCreator

Constructors

constructor

Parameters

Returns SerializableNumericIdentificationKeyCreator

Accessors

serialComponentLength

Returns number

serialComponentCharacterSet

Returns ContentCharacterSet

ProtectedserialComponentValidation

Returns CharacterSetValidation

serialComponentCreator

Returns CharacterSetCreator

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

createSerialized

Type Parameters

Parameters

Returns TransformerOutput<TTransformerInput, string>

concatenate

Type Parameters

Parameters

Returns TransformerOutput<TTransformerInput, string>

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`serialComponentValidation

`Protected` `Static`creatorFor

`Protected`padIdentificationKey

`Protected`validatePrefix

`Protected`init