Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

isLimitSubset.md

46 lines1.0 KB

1---
2id: isLimitSubset
3title: isLimitSubset
4---
5​
6# Function: isLimitSubset()
7​
8```ts
9function isLimitSubset(subset, superset): boolean;
10```
11​
12Defined in: [packages/db/src/query/predicate-utils.ts:773](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L773)
13​
14Check if one limit is a subset of another.
15Returns true if the subset limit requirements are satisfied by the superset limit.
16​
17Note: This function does NOT consider offset. For offset-aware subset checking,
18use `isOffsetLimitSubset` instead.
19​
20## Parameters
21​
22### subset
23​
24The limit requirement to check
25​
26`number` | `undefined`
27​
28### superset
29​
30The limit that might satisfy the requirement
31​
32`number` | `undefined`
33​
34## Returns
35​
36`boolean`
37​
38true if subset is satisfied by superset
39​
40## Example
41​
42```ts
43isLimitSubset(10, 20) // true (requesting 10 items when 20 are available)
44isLimitSubset(20, 10) // false (requesting 20 items when only 10 are available)
45isLimitSubset(10, undefined) // true (requesting 10 items when unlimited are available)
46```