movie-web/providers
1
0
Fork 0
mirror of https://github.com/movie-web/providers.git synced 2025-09-13 18:13:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' into pr-14-v2

Browse Source
This commit is contained in:
Jorrin
2023-12-26 21:48:32 +01:00
parent d8d004e4cb d8f2d0553a
commit 304ef68c5f
78 changed files with 2364 additions and 700 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/fetchers/types.ts
View File

@@ -5,10 +5,13 @@ export type FetcherOptions = {
headers?: Record<string, string>;
query?: Record<string, string>;
method?: 'HEAD' | 'GET' | 'POST';
readHeaders?: string[];
body?: Record<string, any> | string | FormData | URLSearchParams;
returnRaw?: boolean;
};
// Version of the options that always has the defaults set
// This is to make making fetchers yourself easier
export type DefaultedFetcherOptions = {
baseUrl?: string;
body?: Record<string, any> | string | FormData;
@@ -16,13 +19,23 @@ export type DefaultedFetcherOptions = {
query: Record<string, string>;
method: 'HEAD' | 'GET' | 'POST';
returnRaw: boolean;
readHeaders: string[];
};
export type FetcherResponse<T = any> = {
statusCode: number;
headers: Headers;
finalUrl: string;
body: T;
};
// This is the version that will be inputted by library users
export type Fetcher<T = any> = {
(url: string, ops: DefaultedFetcherOptions): Promise<T>;
(url: string, ops: DefaultedFetcherOptions): Promise<FetcherResponse<T>>;
};
// this feature has some quality of life features
// This is the version that scrapers will be interacting with
export type UseableFetcher<T = any> = {
(url: string, ops?: FetcherOptions): Promise<T>;
full: (url: string, ops?: FetcherOptions) => Promise<FetcherResponse<T>>;
};