fraci
    Preparing search index...

    Function fraciBinary

    • Creates a binary-based fractional indexing utility with the specified configuration.

      Type Parameters

      • const X = unknown

        The brand type for the fractional index

      Parameters

      • options: BrandableOptions<Omit<BinaryFraciOptions, "type"> & { type?: "binary" }, X> = {}

        Configuration options for the fractional indexing utility

      Returns Fraci<AnyBinaryFractionalIndexBase, X>

      A binary-based fractional indexing utility instance

      // Create a binary-based fractional indexing utility
      const binaryFraci = fraciBinary({ brand: "exampleIndex" });

      // Generate a key between null and null (first key)
      const [key1] = binaryFraci.generateKeyBetween(null, null);
      // Generate a key between key1 and null (key after key1)
      const [key2] = binaryFraci.generateKeyBetween(key1, null);
      // Generate a key between key1 and key2
      const [key3] = binaryFraci.generateKeyBetween(key1, key2);
      • Fraci - The main fractional indexing utility type
      • BinaryFraciOptions - The options for the binary fractional indexing utility
      • fraci - The unified factory function for creating fractional indexing utilities
      • fraciString - The factory function for creating string-based fractional indexing utilities