Type Alias FraciForDrizzleSync<Config>

FraciForDrizzleSync: Config["fraci"] & {
    indicesForAfter: {
        (
            group: DrizzleFraciGroup<Config>,
            cursor: DrizzleFraciCursor<Config>,
        ):
            | undefined
            | [DrizzleFractionalIndex<Config>, null | DrizzleFractionalIndex<Config>];
        (
            group: DrizzleFraciGroup<Config>,
            cursor: null,
        ): [null, null | DrizzleFractionalIndex<Config>];
    };
    indicesForBefore: {
        (
            group: DrizzleFraciGroup<Config>,
            cursor: DrizzleFraciCursor<Config>,
        ):
            | undefined
            | [null | DrizzleFractionalIndex<Config>, DrizzleFractionalIndex<Config>];
        (
            group: DrizzleFraciGroup<Config>,
            cursor: null,
        ): [null | DrizzleFractionalIndex<Config>, null];
    };
    indicesForFirst: (
        group: DrizzleFraciGroup<Config>,
    ) => [null, DrizzleFractionalIndex<Config> | null];
    indicesForLast: (
        group: DrizzleFraciGroup<Config>,
    ) => [DrizzleFractionalIndex<Config> | null, null];
}

Type representing the enhanced fractional indexing utility for Drizzle ORM with synchronous database engine. This type extends the base fractional indexing utility with additional methods for retrieving indices based on synchronous database queries.

This is the synchronous counterpart to the FraciForDrizzle type.

Type Parameters

Config extends DrizzleFraciConfig
The type of the fractional indexing configuration

Type declaration

ReadonlyindicesForAfter: {
    (
        group: DrizzleFraciGroup<Config>,
        cursor: DrizzleFraciCursor<Config>,
    ):
        | undefined
        | [DrizzleFractionalIndex<Config>, null | DrizzleFractionalIndex<Config>];
    (
        group: DrizzleFraciGroup<Config>,
        cursor: null,
    ): [null, null | DrizzleFractionalIndex<Config>];
}
Returns the indices to calculate the new index of the item to be inserted after the cursor.

Param: group
A record of the columns that uniquely identifies the group.

Param: cursor
A record of the cursor row columns that uniquely identifies the item within a group. If null, this function returns the indices to calculate the new index of the first item in the group.

Returns
The indices to calculate the new index of the item to be inserted after the cursor.
ReadonlyindicesForBefore: {
    (
        group: DrizzleFraciGroup<Config>,
        cursor: DrizzleFraciCursor<Config>,
    ):
        | undefined
        | [null | DrizzleFractionalIndex<Config>, DrizzleFractionalIndex<Config>];
    (
        group: DrizzleFraciGroup<Config>,
        cursor: null,
    ): [null | DrizzleFractionalIndex<Config>, null];
}
Returns the indices to calculate the new index of the item to be inserted before the cursor.

Param: group
A record of the columns that uniquely identifies the group.

Param: cursor
A record of the cursor row columns that uniquely identifies the item within a group. If null, this function returns the indices to calculate the new index of the last item in the group.

Returns
The indices to calculate the new index of the item to be inserted before the cursor.
ReadonlyindicesForFirst: (
group: DrizzleFraciGroup<Config>,
) => [null, DrizzleFractionalIndex<Config> | null]
Returns the indices to calculate the new index of the first item in the group. Identical to indicesForAfter(null, group).
ReadonlyindicesForLast: (
group: DrizzleFraciGroup<Config>,
) => [DrizzleFractionalIndex<Config> | null, null]
Returns the indices to calculate the new index of the last item in the group. Identical to indicesForBefore(null, group).

See

Fraci - The base fractional indexing utility type
drizzleFraciSync - The main function to create an instance of this type
FraciForDrizzle - The asynchronous version of this type

Type Alias FraciForDrizzleSync<Config>

Type Parameters

Type declaration

Param: group

Param: cursor

Returns

Param: group

Param: cursor

Returns

`Readonly`indicesForFirst: (
group: DrizzleFraciGroup<Config>,
) => [null, DrizzleFractionalIndex<Config> | null]

`Readonly`indicesForLast: (
group: DrizzleFraciGroup<Config>,
) => [DrizzleFractionalIndex<Config> | null, null]

See

Settings

Type Alias FraciForDrizzleSync<Config>

Type Parameters

Type declaration

ReadonlyindicesForAfter: { ( group: DrizzleFraciGroup<Config>, cursor: DrizzleFraciCursor<Config>, ): | undefined | [DrizzleFractionalIndex<Config>, null | DrizzleFractionalIndex<Config>]; ( group: DrizzleFraciGroup<Config>, cursor: null, ): [null, null | DrizzleFractionalIndex<Config>];}

Param: group

Param: cursor

Returns

ReadonlyindicesForBefore: { ( group: DrizzleFraciGroup<Config>, cursor: DrizzleFraciCursor<Config>, ): | undefined | [null | DrizzleFractionalIndex<Config>, DrizzleFractionalIndex<Config>]; ( group: DrizzleFraciGroup<Config>, cursor: null, ): [null | DrizzleFractionalIndex<Config>, null];}

Param: group

Param: cursor

Returns

ReadonlyindicesForFirst: ( group: DrizzleFraciGroup<Config>,) => [null, DrizzleFractionalIndex<Config> | null]

ReadonlyindicesForLast: ( group: DrizzleFraciGroup<Config>,) => [DrizzleFractionalIndex<Config> | null, null]

See

Settings

`Readonly`indicesForAfter: {
(
group: DrizzleFraciGroup<Config>,
cursor: DrizzleFraciCursor<Config>,
):
| undefined
| [DrizzleFractionalIndex<Config>, null | DrizzleFractionalIndex<Config>];
(
group: DrizzleFraciGroup<Config>,
cursor: null,
): [null, null | DrizzleFractionalIndex<Config>];
}

`Readonly`indicesForBefore: {
(
group: DrizzleFraciGroup<Config>,
cursor: DrizzleFraciCursor<Config>,
):
| undefined
| [null | DrizzleFractionalIndex<Config>, DrizzleFractionalIndex<Config>];
(
group: DrizzleFraciGroup<Config>,
cursor: null,
): [null | DrizzleFractionalIndex<Config>, null];
}

`Readonly`indicesForFirst: (
group: DrizzleFraciGroup<Config>,
) => [null, DrizzleFractionalIndex<Config> | null]

`Readonly`indicesForLast: (
group: DrizzleFraciGroup<Config>,
) => [DrizzleFractionalIndex<Config> | null, null]