forked from sindresorhus/p-pipe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
152 lines (143 loc) · 4.59 KB
/
index.d.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
declare namespace pPipe {
type UnaryFunction<ValueType, ReturnType> = (
value: ValueType
) => ReturnType | PromiseLike<ReturnType>;
type Pipeline<ValueType, ReturnType> = (
value: ValueType
) => Promise<ReturnType>;
}
/**
Compose promise-returning & async functions into a reusable pipeline.
@param ...input - Iterated over sequentially when returned `function` is called.
@returns The `input` functions are applied from left to right.
@example
```
import pPipe = require('p-pipe');
const addUnicorn = async string => `${string} Unicorn`;
const addRainbow = async string => `${string} Rainbow`;
const pipeline = pPipe(addUnicorn, addRainbow);
(async () => {
console.log(await pipeline('❤️'));
//=> '❤️ Unicorn Rainbow'
})();
```
*/
declare function pPipe<ValueType, ReturnType>(
f1: pPipe.UnaryFunction<ValueType, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<ValueType, ResultValue1, ReturnType>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<ValueType, ResultValue1, ResultValue2, ReturnType>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ResultValue4,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ResultValue4>,
f5: pPipe.UnaryFunction<ResultValue4, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ResultValue4,
ResultValue5,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ResultValue4>,
f5: pPipe.UnaryFunction<ResultValue4, ResultValue5>,
f6: pPipe.UnaryFunction<ResultValue5, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ResultValue4,
ResultValue5,
ResultValue6,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ResultValue4>,
f5: pPipe.UnaryFunction<ResultValue4, ResultValue5>,
f6: pPipe.UnaryFunction<ResultValue5, ResultValue6>,
f7: pPipe.UnaryFunction<ResultValue6, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ResultValue4,
ResultValue5,
ResultValue6,
ResultValue7,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ResultValue4>,
f5: pPipe.UnaryFunction<ResultValue4, ResultValue5>,
f6: pPipe.UnaryFunction<ResultValue5, ResultValue6>,
f7: pPipe.UnaryFunction<ResultValue6, ResultValue7>,
f8: pPipe.UnaryFunction<ResultValue7, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
declare function pPipe<
ValueType,
ResultValue1,
ResultValue2,
ResultValue3,
ResultValue4,
ResultValue5,
ResultValue6,
ResultValue7,
ResultValue8,
ReturnType
>(
f1: pPipe.UnaryFunction<ValueType, ResultValue1>,
f2: pPipe.UnaryFunction<ResultValue1, ResultValue2>,
f3: pPipe.UnaryFunction<ResultValue2, ResultValue3>,
f4: pPipe.UnaryFunction<ResultValue3, ResultValue4>,
f5: pPipe.UnaryFunction<ResultValue4, ResultValue5>,
f6: pPipe.UnaryFunction<ResultValue5, ResultValue6>,
f7: pPipe.UnaryFunction<ResultValue6, ResultValue7>,
f8: pPipe.UnaryFunction<ResultValue7, ResultValue8>,
f9: pPipe.UnaryFunction<ResultValue8, ReturnType>
): pPipe.Pipeline<ValueType, ReturnType>;
// Fallbacks if more than 9 functions are passed as input (not type-safe).
declare function pPipe(
...functions: (pPipe.UnaryFunction<any, unknown>)[]
): pPipe.Pipeline<unknown, unknown>;
export = pPipe;