UNPKG

9.12 kBTypeScriptView Raw
1import type { Head, Tail } from "./tuple.js";
2/**
3 * A version of `T` in which only keys in K are mandatory and the rest are
4 * considered optional.
5 */
6export type SomeRequired<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>;
7/**
8 * Extracts from A all keys which have values assignable to type B.
9 */
10export type TypedKeys<A, B> = {
11 [P in Keys<A>]: B extends A[P] ? P : never;
12}[keyof A];
13export type NumericKeys<T> = TypedKeys<T, number>;
14export type StringKeys<T> = TypedKeys<T, string>;
15export type DeepPartial<T> = Partial<{
16 [k in keyof T]: DeepPartial<T[k]>;
17}>;
18export type Keys<T> = keyof Required<T>;
19export type Keys1<T, A extends Keys<T>> = Keys<Required<T>[A]>;
20export type Keys2<T, A extends Keys<T>, B extends Keys1<T, A>> = Keys1<Required<T>[A], B>;
21export type Keys3<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>> = Keys2<Required<T>[A], B, C>;
22export type Keys4<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>> = Keys3<Required<T>[A], B, C, D>;
23export type Keys5<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>> = Keys4<Required<T>[A], B, C, D, E>;
24export type Keys6<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>> = Keys5<Required<T>[A], B, C, D, E, F>;
25export type Keys7<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>> = Keys6<Required<T>[A], B, C, D, E, F, G>;
26export type Keys8<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>, H extends Keys7<T, A, B, C, D, E, F, G>> = Keys7<Required<T>[A], B, C, D, E, F, G, H>;
27/**
28 * Internal type used as a reducer for the KeyN type.
29 *
30 * @internal
31 *
32 * @param T - structure to validate the key against.
33 * @param L - Current value.
34 * @param R - Remaining values.
35 */
36type KeysNReducer<T, L, R extends unknown[]> = L extends keyof T ? {
37 0: keyof Required<T>[L];
38 1: KeysNReducer<Required<T>[L], Head<R>, Tail<R>>;
39}[R extends [] ? 0 : 1] : never;
40/**
41 * Generalised version of Keys0 - Keys7.
42 */
43export type KeysN<T, L extends unknown[]> = L extends [] ? Keys<T> : KeysNReducer<T, Head<L>, Tail<L>>;
44export type Val1<T, A extends Keys<T>> = T[A];
45export type Val2<T, A extends Keys<T>, B extends Keys1<T, A>> = ValN<T, [A, B]>;
46export type Val3<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>> = ValN<T, [A, B, C]>;
47export type Val4<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>> = ValN<T, [A, B, C, D]>;
48export type Val5<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>> = ValN<T, [A, B, C, D, E]>;
49export type Val6<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>> = ValN<T, [A, B, C, D, E, F]>;
50export type Val7<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>> = ValN<T, [A, B, C, D, E, F, G]>;
51export type Val8<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>, H extends Keys7<T, A, B, C, D, E, F, G>> = ValN<T, [A, B, C, D, E, F, G, H]>;
52/**
53 * Internal reducer for ValN.
54 *
55 * @internal
56 *
57 * @param T - he structure to get the values from.
58 * @param C - he current key.
59 * @param R - he remaining keys
60 */
61type ValNReducer<T, C, R extends unknown[]> = C extends keyof T ? {
62 0: T[C];
63 1: ValNReducer<Required<T>[C], Head<R>, Tail<R>>;
64}[R extends [] ? 0 : 1] : never;
65/**
66 * Generalised version of Val1-Val7
67 */
68export type ValN<T, L extends unknown[]> = L extends [] ? T : ValNReducer<T, Head<L>, Tail<L>>;
69/**
70 * Utilities for constructing types with nested keys removed.
71 */
72export type Without<T, A extends Keys<T>> = Omit<T, A>;
73export type Without2<T, A extends Keys<T>, B extends Keys1<T, A>> = Without<T, A> & {
74 [id in A]: Without<Val1<T, A>, B>;
75};
76export type Without3<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>> = Without<T, A> & {
77 [id in A]: Without2<Val1<T, A>, B, C>;
78};
79export type Without4<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>> = Without<T, A> & {
80 [id in A]: Without3<Val1<T, A>, B, C, D>;
81};
82export type Without5<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>> = Without<T, A> & {
83 [id in A]: Without4<Val1<T, A>, B, C, D, E>;
84};
85export type Without6<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>> = Without<T, A> & {
86 [id in A]: Without5<Val1<T, A>, B, C, D, E, F>;
87};
88export type Without7<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>> = Without<T, A> & {
89 [id in A]: Without6<Val1<T, A>, B, C, D, E, F, G>;
90};
91export type Without8<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>, H extends Keys7<T, A, B, C, D, E, F, G>> = Without<T, A> & {
92 [id in A]: Without7<Val1<T, A>, B, C, D, E, F, G, H>;
93};
94/**
95 * Internal reducer used as a building block for WithoutN.
96 *
97 * @internal
98 *
99 * @param T - he structure to remove keys from.
100 * @param C - he current key.
101 * @param R - he remaining keys.
102 */
103type WithoutNReducer<T, C, R extends unknown[]> = C extends keyof T ? {
104 0: Without<T, C>;
105 1: Without<T, C> & Record<C, WithoutNReducer<T[C], Head<R>, Tail<R>>>;
106}[R extends [] ? 0 : 1] : never;
107/**
108 * Generalised version of Without0-Without8.
109 */
110export type WithoutN<T, P extends unknown[]> = WithoutNReducer<T, Head<P>, Tail<P>>;
111/**
112 * Utilities for replacing types of nested keys.
113 */
114export type Replace<T, A extends Keys<T>, V> = Without<T, A> & {
115 [id in A]: V;
116};
117export type Replace2<T, A extends Keys<T>, B extends Keys1<T, A>, V> = Without<T, A> & {
118 [id in A]: Replace<Val1<T, A>, B, V>;
119};
120export type Replace3<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, V> = Without<T, A> & {
121 [id in A]: Replace2<Val1<T, A>, B, C, V>;
122};
123export type Replace4<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, V> = Without<T, A> & {
124 [id in A]: Replace3<Val1<T, A>, B, C, D, V>;
125};
126export type Replace5<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, V> = Without<T, A> & {
127 [id in A]: Replace4<Val1<T, A>, B, C, D, E, V>;
128};
129export type Replace6<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, V> = Without<T, A> & {
130 [id in A]: Replace5<Val1<T, A>, B, C, D, E, F, V>;
131};
132export type Replace7<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>, V> = Without<T, A> & {
133 [id in A]: Replace6<Val1<T, A>, B, C, D, E, F, G, V>;
134};
135export type Replace8<T, A extends Keys<T>, B extends Keys1<T, A>, C extends Keys2<T, A, B>, D extends Keys3<T, A, B, C>, E extends Keys4<T, A, B, C, D>, F extends Keys5<T, A, B, C, D, E>, G extends Keys6<T, A, B, C, D, E, F>, H extends Keys7<T, A, B, C, D, E, F, G>, V> = Without<T, A> & {
136 [id in A]: Replace7<Val1<T, A>, B, C, D, E, F, G, H, V>;
137};
138/**
139 * Internal reducer used as a building block for ReduceN.
140 *
141 * @internal
142 *
143 * @param T - he structure to remove keys from.
144 * @param C - he current key.
145 * @param R - he remaining keys.
146 * @param V - he type to use for the replacement.
147 */
148type ReplaceNReducer<T, C, R extends unknown[], V> = C extends keyof T ? {
149 0: Replace<T, C, V>;
150 1: Without<T, C> & Record<C, ReplaceNReducer<T[C], Head<R>, Tail<R>, V>>;
151}[R extends [] ? 0 : 1] : never;
152/**
153 * Generalised version of Replace0-Replace8.
154 */
155export type ReplaceN<T, P extends unknown[], V> = ReplaceNReducer<T, Head<P>, Tail<P>, V>;
156export {};
157//# sourceMappingURL=keyval.d.ts.map
\No newline at end of file