1 |
|
2 | import type { Buffer } from 'node:buffer';
|
3 | import type { CancelableRequest } from './as-promise/types.js';
|
4 | import type { Response } from './core/response.js';
|
5 | import type Options from './core/options.js';
|
6 | import { type PaginationOptions, type OptionsInit } from './core/options.js';
|
7 | import type Request from './core/index.js';
|
8 | type Except<ObjectType, KeysType extends keyof ObjectType> = Pick<ObjectType, Exclude<keyof ObjectType, KeysType>>;
|
9 | type Merge<FirstType, SecondType> = Except<FirstType, Extract<keyof FirstType, keyof SecondType>> & SecondType;
|
10 |
|
11 |
|
12 |
|
13 | export type InstanceDefaults = {
|
14 | |
15 |
|
16 |
|
17 | options: Options;
|
18 | |
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 |
|
25 | handlers: HandlerFunction[];
|
26 | |
27 |
|
28 |
|
29 |
|
30 |
|
31 |
|
32 | mutableDefaults: boolean;
|
33 | };
|
34 |
|
35 |
|
36 |
|
37 | export type GotReturn = Request | CancelableRequest;
|
38 |
|
39 |
|
40 |
|
41 |
|
42 | export type HandlerFunction = <T extends GotReturn>(options: Options, next: (options: Options) => T) => T | Promise<T>;
|
43 |
|
44 |
|
45 |
|
46 | export type ExtendOptions = {
|
47 | |
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 | handlers?: HandlerFunction[];
|
55 | |
56 |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 | mutableDefaults?: boolean;
|
62 | } & OptionsInit;
|
63 | export type OptionsOfTextResponseBody = Merge<OptionsInit, {
|
64 | isStream?: false;
|
65 | resolveBodyOnly?: false;
|
66 | responseType?: 'text';
|
67 | }>;
|
68 | export type OptionsOfJSONResponseBody = Merge<OptionsInit, {
|
69 | isStream?: false;
|
70 | resolveBodyOnly?: false;
|
71 | responseType?: 'json';
|
72 | }>;
|
73 | export type OptionsOfBufferResponseBody = Merge<OptionsInit, {
|
74 | isStream?: false;
|
75 | resolveBodyOnly?: false;
|
76 | responseType: 'buffer';
|
77 | }>;
|
78 | export type OptionsOfUnknownResponseBody = Merge<OptionsInit, {
|
79 | isStream?: false;
|
80 | resolveBodyOnly?: false;
|
81 | }>;
|
82 | export type StrictOptions = Except<OptionsInit, 'isStream' | 'responseType' | 'resolveBodyOnly'>;
|
83 | export type StreamOptions = Merge<OptionsInit, {
|
84 | isStream?: true;
|
85 | }>;
|
86 | type ResponseBodyOnly = {
|
87 | resolveBodyOnly: true;
|
88 | };
|
89 | export type OptionsWithPagination<T = unknown, R = unknown> = Merge<OptionsInit, {
|
90 | pagination?: PaginationOptions<T, R>;
|
91 | }>;
|
92 |
|
93 |
|
94 |
|
95 | export type GotPaginate = {
|
96 | |
97 |
|
98 |
|
99 | <T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
|
100 | |
101 |
|
102 |
|
103 | <T, R = unknown>(options?: OptionsWithPagination<T, R>): AsyncIterableIterator<T>;
|
104 | |
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 | each: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => AsyncIterableIterator<T>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => AsyncIterableIterator<T>);
|
127 | /**
|
128 | Returns a Promise for an array of all results.
|
129 |
|
130 | See pagination.options for more pagination options.
|
131 |
|
132 | @example
|
133 | ```
|
134 | import got from 'got';
|
135 |
|
136 | const countLimit = 10;
|
137 |
|
138 | const results = await got.paginate.all('https:
|
139 | pagination: {countLimit}
|
140 | });
|
141 |
|
142 | console.log(`Printing latest ${countLimit} Got commits (newest to oldest):`);
|
143 | console.log(results);
|
144 | ```
|
145 | */
|
146 | all: (<T, R = unknown>(url: string | URL, options?: OptionsWithPagination<T, R>) => Promise<T[]>) & (<T, R = unknown>(options?: OptionsWithPagination<T, R>) => Promise<T[]>);
|
147 | };
|
148 | export type GotRequestFunction = {
|
149 | (url: string | URL, options?: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
|
150 | <T>(url: string | URL, options?: OptionsOfJSONResponseBody): CancelableRequest<Response<T>>;
|
151 | (url: string | URL, options?: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;
|
152 | (url: string | URL, options?: OptionsOfUnknownResponseBody): CancelableRequest<Response>;
|
153 | (options: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
|
154 | <T>(options: OptionsOfJSONResponseBody): CancelableRequest<Response<T>>;
|
155 | (options: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;
|
156 | (options: OptionsOfUnknownResponseBody): CancelableRequest<Response>;
|
157 | (url: string | URL, options?: (Merge<OptionsOfTextResponseBody, ResponseBodyOnly>)): CancelableRequest<string>;
|
158 | <T>(url: string | URL, options?: (Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>)): CancelableRequest<T>;
|
159 | (url: string | URL, options?: (Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>)): CancelableRequest<Buffer>;
|
160 | (options: (Merge<OptionsOfTextResponseBody, ResponseBodyOnly>)): CancelableRequest<string>;
|
161 | <T>(options: (Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>)): CancelableRequest<T>;
|
162 | (options: (Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>)): CancelableRequest<Buffer>;
|
163 | (url: string | URL, options?: Merge<OptionsInit, {
|
164 | isStream: true;
|
165 | }>): Request;
|
166 | (options: Merge<OptionsInit, {
|
167 | isStream: true;
|
168 | }>): Request;
|
169 | (url: string | URL, options?: OptionsInit): CancelableRequest | Request;
|
170 | (options: OptionsInit): CancelableRequest | Request;
|
171 | (url: undefined, options: undefined, defaults: Options): CancelableRequest | Request;
|
172 | };
|
173 | /**
|
174 | All available HTTP request methods provided by Got.
|
175 | */
|
176 | export type HTTPAlias = 'get' | 'post' | 'put' | 'patch' | 'head' | 'delete';
|
177 | type GotStreamFunction = ((url?: string | URL, options?: Merge<OptionsInit, {
|
178 | isStream?: true;
|
179 | }>) => Request) & ((options?: Merge<OptionsInit, {
|
180 | isStream?: true;
|
181 | }>) => Request);
|
182 | /**
|
183 | An instance of `got.stream()`.
|
184 | */
|
185 | export type GotStream = GotStreamFunction & Record<HTTPAlias, GotStreamFunction>;
|
186 | /**
|
187 | An instance of `got`.
|
188 | */
|
189 | export type Got = {
|
190 | /**
|
191 | Sets `options.isStream` to `true`.
|
192 |
|
193 | Returns a [duplex stream](https:
|
194 | - request
|
195 | - response
|
196 | - redirect
|
197 | - uploadProgress
|
198 | - downloadProgress
|
199 | - error
|
200 | */
|
201 | stream: GotStream;
|
202 | |
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 | paginate: GotPaginate;
|
225 | |
226 |
|
227 |
|
228 | defaults: InstanceDefaults;
|
229 | |
230 |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 | extend: (...instancesOrOptions: Array<Got | ExtendOptions>) => Got;
|
260 | } & Record<HTTPAlias, GotRequestFunction> & GotRequestFunction;
|
261 | export {};
|
262 |
|
\ | No newline at end of file |