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