Class FractionalIndexGenerator

Generator of random fractional index strings.

Implements

IndexGenerator<string>

Index

Constructors

Properties

minRandBits rand

Methods

create validate

Constructors

constructor

new FractionalIndexGenerator(rand?, minRandBits?): FractionalIndexGenerator
Parameters
- rand: (() => number) = Math.random
  The random function. Defaults to Math.random.
  - - (): number
    - The random function. Defaults to Math.random.
      
      Returns number
- minRandBits: number = 48
  Number of random bits to use when generating random indices. Defaults to 48 bits.
Returns FractionalIndexGenerator
- Defined in crdt/src/utils/fractional.ts:7

Properties

`Protected` `Readonly` minRandBits

minRandBits: number = 48

Number of random bits to use when generating random indices. Defaults to 48 bits.

`Protected` `Readonly` rand

rand: (() => number) = Math.random

Type declaration

- (): number
- The random function. Defaults to Math.random.
  
  Returns number

Methods

create

create(start?, end?, count?): IterableIterator<string>
Generates count indices between start and end exclusively.
Parameters
- Optional start: string
- Optional end: string
- count: number = 1
Returns IterableIterator<string>
Implementation of IndexGenerator.create
- Defined in crdt/src/utils/fractional.ts:14

validate

validate(index): boolean
Returns if given index is valid for this generator.
Parameters
- index: string
Returns boolean
Implementation of IndexGenerator.validate
- Defined in crdt/src/utils/fractional.ts:50

Generated using TypeDoc