Repository navigation
Expand file tree
/
Copy pathscan-options.ts
More file actions
123 lines (108 loc) · 3.48 KB
/
Copy pathscan-options.ts
File metadata and controls
123 lines (108 loc) · 3.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/**
* Options for [[ReadTransaction.scan|scan]] and
* [[ReadTransaction.scanAll|scanAll]]
*/
export type ScanOptions = ScanIndexOptions | ScanNoIndexOptions;
/**
* Options for [[ReadTransaction.scan|scan]] and
* [[ReadTransaction.scanAll|scanAll]] when scanning over the entire key space.
*/
export type ScanNoIndexOptions = {
/** Only include keys starting with `prefix`. */
prefix?: string;
/** Only include up to `limit` results. */
limit?: number;
/** When provided the scan starts at this key. */
start?: {
key: string;
/** Whether the `key` is exclusive or inclusive. */
exclusive?: boolean;
};
};
/**
* Options for [[ReadTransaction.scan|scan]] and
* [[ReadTransaction.scanAll|scanAll]] when scanning over an index. When
* scanning over and index you need to provide the `indexName` and the `start`
* `key` is now a tuple consisting of secondar and primary key
*/
export type ScanIndexOptions = {
/** Only include results starting with the *secondary* keys starting with `prefix`. */
prefix?: string;
/** Only include up to `limit` results. */
limit?: number;
/** Do a [[ReadTransaction.scan|scan]] over a named index. The `indexName`
* is the name of an index previously created with [[createIndex]]. */
indexName: string;
/** When provided the scan starts at this key. */
start?: {
key: ScanOptionIndexedStartKey;
/** Whether the `key` is exclusive or inclusive. */
exclusive?: boolean;
};
};
/**
* If the options contains an `indexName` then the key type is a tuple of
* secondary and primary.
*/
export type KeyTypeForScanOptions<O extends ScanOptions> = O extends {
indexName: string;
}
? [secondary: string, primary: string]
: string;
/**
* The key to start scanning at.
*
* If you are scanning the primary index (i.e., you did not specify
* `indexName`), then pass a single string for this field, which is the key in
* the primary index to scan at.
*
* If you are scanning a secondary index (i.e., you specified `indexName`), then
* use the tuple form. In that case, `secondary` is the secondary key to start
* scanning at, and `primary` (if any) is the primary key to start scanning at.
*/
export type ScanOptionIndexedStartKey =
| [secondary: string, primary?: string]
| string;
export interface ScanOptionsRPC {
/* eslint-disable @typescript-eslint/naming-convention */
prefix?: string;
start_secondary_key?: string;
start_key?: string;
start_exclusive?: boolean;
limit?: number;
indexName?: string;
/* eslint-enable @typescript-eslint/naming-convention */
}
export function toRPC(options?: ScanOptions): ScanOptionsRPC {
if (!options) {
return {};
}
let key: string | ScanOptionIndexedStartKey | undefined;
let exclusive: boolean | undefined;
let primary: string | undefined;
let secondary: string | undefined;
type MaybeIndexName = {indexName?: string};
if (options.start) {
({key, exclusive} = options.start);
if ((options as MaybeIndexName).indexName) {
if (typeof key === 'string') {
secondary = key;
} else {
secondary = key[0];
primary = key[1];
}
} else {
primary = key as string;
}
}
return {
/* eslint-disable @typescript-eslint/naming-convention */
prefix: options.prefix,
start_secondary_key: secondary,
start_key: primary,
start_exclusive: exclusive,
limit: options.limit,
indexName: (options as MaybeIndexName).indexName,
/* eslint-enable @typescript-eslint/naming-convention */
};
}