Class SerializableNumericIdentificationKeyCreator

Serializable numeric identification key creator.

Hierarchy

Properties

leaderType identificationKeyType prefixType length referenceCharacterSet referenceValidator

Constructors

constructor

Accessors

serialComponentCreator serialComponentLength serialComponentCharacterSet serialComponentValidation serialComponentValidator capacity tweak referenceCreator prefixManager prefix referenceLength

Methods

validatorFor padIdentificationKey createSerialized concatenate validate validatePrefix init create createAll

Properties

leaderType

leaderType: LeaderType

identificationKeyType

identificationKeyType: IdentificationKeyType

prefixType

prefixType: PrefixType

length

length: number

referenceCharacterSet

referenceCharacterSet: CharacterSet

referenceValidator

referenceValidator: CharacterSetValidator

Constructors

constructor

  • new SerializableNumericIdentificationKeyCreator(prefixManager, identificationKeyType, length, serialComponentLength, serialComponentCharacterSet): 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: CharacterSet

      Serial component character set.

    Returns SerializableNumericIdentificationKeyCreator

Accessors

serialComponentCreator

serialComponentLength

  • get serialComponentLength(): number

  • Get the serial component length.

    Returns number

serialComponentCharacterSet

  • get serialComponentCharacterSet(): CharacterSet

  • Get the serial component character set.

    Returns CharacterSet

ProtectedserialComponentValidation

  • get serialComponentValidation(): CharacterSetValidation

  • Get the serial component validation parameters.

    Returns CharacterSetValidation

serialComponentValidator

  • get serialComponentValidator(): CharacterSetValidator

  • Get the serial component validator.

    Returns CharacterSetValidator

capacity

  • get capacity(): number

  • Returns number

    Inherit Doc

tweak

  • get tweak(): bigint

  • Get the tweak for sparse creation.

    Returns bigint

  • set tweak(value): void

  • Set the tweak for sparse creation.

    Parameters

    • value: bigint

    Returns void

referenceCreator

prefixManager

  • get prefixManager(): PrefixManager

  • Returns PrefixManager

    Inherit Doc

prefix

  • get prefix(): string

  • Returns string

    Inherit Doc

referenceLength

  • get referenceLength(): number

  • Returns number

    Inherit Doc

Methods

Protected StaticvalidatorFor

  • validatorFor(characterSet): CharacterSetValidator

  • Get the character set validator for a character set.

    Parameters

    Returns CharacterSetValidator

    Character set validator.

Protected StaticpadIdentificationKey

  • padIdentificationKey(identificationKey, validation): string

  • Pad an identification key on the left with zeroes 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.

createSerialized

  • createSerialized(value, serialComponent, sparse?): string

  • Create a serialized identification key with a reference based on a numeric value and a serial component. The value is converted to a reference of the appropriate length using NUMERIC_CREATOR.

    Parameters

    • value: number

      Numeric value of the references.

    • serialComponent: string

      Serial component.

    • Optionalsparse: boolean

      If true, the value is mapped to a sparse sequence resistant to discovery. Default is false.

    Returns string

    Serialized identification key.

  • createSerialized(value, serialComponents, sparse?): IterableIterator<string, any, any>

  • Create multiple serialized identification keys with a reference based on a numeric value and multiple serial components. The value is converted to a reference of the appropriate length using NUMERIC_CREATOR.

    Parameters

    • value: number

      Numeric value.

    • serialComponents: Iterable<string, any, any>

      Serial components.

    • Optionalsparse: boolean

      If true, the value is mapped to a sparse sequence resistant to discovery. Default is false.

    Returns IterableIterator<string, any, any>

    Serialized identification keys.

concatenate

  • concatenate(baseIdentificationKey, serialComponent): string

  • Concatenate a base identification key with a serial component.

    Parameters

    • baseIdentificationKey: string

      Base identification key.

    • serialComponent: string

      Serial component.

    Returns string

    Serialized identification key.

  • concatenate(baseIdentificationKey, serialComponents): IterableIterator<string, any, any>

  • Concatenate a base identification key with multiple serial components.

    Parameters

    • baseIdentificationKey: string

      Base identification key.

    • serialComponents: Iterable<string, any, any>

      Serial components.

    Returns IterableIterator<string, any, any>

    Serialized identification keys.

validate

  • validate(identificationKey, validation?): void

  • Parameters

    Returns void

ProtectedvalidatePrefix

  • validatePrefix(partialIdentificationKey, positionOffset?): void

  • Validate the prefix within an identification key.

    Parameters

    • partialIdentificationKey: string

      Partial identification key.

    • OptionalpositionOffset: number

      Position offset within a larger string.

    Returns void

Protectedinit

  • init(prefixManager, prefix): 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

create

  • create(value, sparse?): string

  • Parameters

    • value: number | bigint
    • Optionalsparse: boolean

    Returns string

    Inherit Doc

  • create(values, sparse?): IterableIterator<string, any, any>

  • Parameters

    • values: Iterable<number | bigint, any, any>
    • Optionalsparse: boolean

    Returns IterableIterator<string, any, any>

    Inherit Doc

createAll

  • createAll(): IterableIterator<string, any, any>

  • Returns IterableIterator<string, any, any>

    Inherit Doc

Settings

Member Visibility

On This Page

Properties
Constructors
Accessors
Methods