-
Notifications
You must be signed in to change notification settings - Fork 280
/
type-utils.ts
162 lines (148 loc) · 3.45 KB
/
type-utils.ts
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import { SelectQueryBuilder } from '../query-builder/select-query-builder.js'
import { InsertResult } from '../query-builder/insert-result.js'
import { DeleteResult } from '../query-builder/delete-result.js'
import { UpdateResult } from '../query-builder/update-result.js'
/**
* Given an object type, extracts the union of all value types.
*/
export type ValueType<T> = T[keyof T]
/**
* Given a database type and a union of table names in that db, returns
* a union type with all possible column names.
*
* Example:
*
* ```ts
* interface Person {
* id: number
* }
*
* interface Pet {
* name: string
* species: 'cat' | 'dog'
* }
*
* interface Movie {
* stars: number
* }
*
* interface Database {
* person: Person
* pet: Pet
* movie: Movie
* }
*
* type Columns = AnyColumn<Database, 'person' | 'pet'>
*
* // Columns == 'id' | 'name' | 'species'
* ```
*/
export type AnyColumn<DB, TB extends keyof DB> = {
[T in TB]: keyof DB[T]
}[TB] &
string
/**
* Extracts a column type.
*/
export type ExtractColumnType<DB, TB extends keyof DB, C> = {
[T in TB]: C extends keyof DB[T] ? DB[T][C] : never
}[TB]
/**
* Given a database type and a union of table names in that db, returns
* a union type with all possible `table`.`column` combinations.
*
* Example:
*
* ```ts
* interface Person {
* id: number
* }
*
* interface Pet {
* name: string
* species: 'cat' | 'dog'
* }
*
* interface Movie {
* stars: number
* }
*
* interface Database {
* person: Person
* pet: Pet
* movie: Movie
* }
*
* type Columns = AnyColumnWithTable<Database, 'person' | 'pet'>
*
* // Columns == 'person.id' | 'pet.name' | 'pet.species'
* ```
*/
export type AnyColumnWithTable<DB, TB extends keyof DB> = {
[T in TB]: T extends string
? keyof DB[T] extends string
? `${T}.${keyof DB[T]}`
: never
: never
}[TB]
/**
* Just like {@link AnyColumn} but with a ` as <string>` suffix.
*/
export type AnyAliasedColumn<DB, TB extends keyof DB> = {
[T in TB]: T extends string
? keyof DB[T] extends string
? `${keyof DB[T]} as ${string}`
: never
: never
}[TB]
/**
* Just like {@link AnyColumnWithTable} but with a ` as <string>` suffix.
*/
export type AnyAliasedColumnWithTable<DB, TB extends keyof DB> = {
[T in TB]: T extends string
? keyof DB[T] extends string
? `${T}.${keyof DB[T]} as ${string}`
: never
: never
}[TB]
/**
* Extracts the item type of an array.
*/
export type ArrayItemType<T> = T extends ReadonlyArray<infer I> ? I : never
export type AnySelectQueryBuilder = SelectQueryBuilder<any, any, any>
export type SingleResultType<O> = O extends InsertResult
? O
: O extends DeleteResult
? O
: O extends UpdateResult
? O
: O | undefined
export type UnknownRow = Record<string, unknown>
export type Nullable<T> = { [P in keyof T]: T[P] | null }
/**
* Takes all properties from T1 and merges all properties from T2
* that don't exist in T1 as optional properties.
*
* Example:
*
* interface Person {
* name: string
* age: number
* }
*
* interface Pet {
* name: string
* species: 'cat' | 'dog'
* }
*
* type Merged = MergePartial<Person, Pet>
*
* // { name: string, age: number, species?: 'cat' | 'dog' }
*/
export type MergePartial<T1, T2> = T1 & Partial<Omit<T2, keyof T1>>
export type IsNever<T> = [T] extends [never] ? true : false
export type Equals<T, U> = (<G>() => G extends T ? 1 : 2) extends <
G
>() => G extends U ? 1 : 2
? true
: false