-
-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enhance: Improve legacy TypeScript compatibility (#2505)
- Loading branch information
Showing
19 changed files
with
460 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,6 @@ | |
| /dist | ||
| /legacy | ||
| /index.d.ts | ||
| /ts3.4 | ||
| /ts4.0 | ||
| /ts4.2 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| // relaxed constraints on call,apply,bind *this* | ||
|
|
||
| /* eslint-disable @typescript-eslint/ban-types */ | ||
| import type { EndpointInterface, Schema } from './interface.js'; | ||
| import type { | ||
| EndpointExtraOptions, | ||
| FetchFunction, | ||
| PartialArray, | ||
| } from './types.js'; | ||
|
|
||
| export interface EndpointOptions< | ||
| F extends FetchFunction = FetchFunction, | ||
| S extends Schema | undefined = undefined, | ||
| M extends true | undefined = undefined, | ||
| > extends EndpointExtraOptions<F> { | ||
| key?: (...args: Parameters<F>) => string; | ||
| sideEffect?: M; | ||
| schema?: S; | ||
| [k: string]: any; | ||
| } | ||
|
|
||
| export interface EndpointExtendOptions< | ||
| F extends FetchFunction = FetchFunction, | ||
| S extends Schema | undefined = Schema | undefined, | ||
| M extends true | undefined = true | undefined, | ||
| > extends EndpointOptions<F, S, M> { | ||
| fetch?: FetchFunction; | ||
| } | ||
|
|
||
| export type ParamFromFetch<F> = F extends ( | ||
| params: infer P, | ||
| body?: any, | ||
| ) => Promise<any> | ||
| ? P | ||
| : never; | ||
|
|
||
| type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U; | ||
|
|
||
| export type KeyofEndpointInstance = keyof EndpointInstance<FetchFunction>; | ||
|
|
||
| export type ExtendedEndpoint< | ||
| O extends EndpointExtendOptions<F>, | ||
| E extends EndpointInstance< | ||
| FetchFunction, | ||
| Schema | undefined, | ||
| true | undefined | ||
| >, | ||
| F extends FetchFunction, | ||
| > = EndpointInstance< | ||
| 'fetch' extends keyof O ? Exclude<O['fetch'], undefined> : E['fetch'], | ||
| 'schema' extends keyof O ? O['schema'] : E['schema'], | ||
| 'sideEffect' extends keyof O ? O['sideEffect'] : E['sideEffect'] | ||
| > & | ||
| Omit<O, KeyofEndpointInstance> & | ||
| Omit<E, KeyofEndpointInstance>; | ||
|
|
||
| export function Make(...args: any[]): EndpointInstance<FetchFunction>; | ||
|
|
||
| /** | ||
| * Defines an async data source. | ||
| * @see https://resthooks.io/docs/api/Endpoint | ||
| */ | ||
| export interface EndpointInstance< | ||
| F extends (...args: any) => Promise<any> = FetchFunction, | ||
| S extends Schema | undefined = Schema | undefined, | ||
| M extends true | undefined = true | undefined, | ||
| > extends EndpointInstanceInterface<F, S, M> { | ||
| extend< | ||
| E extends EndpointInstance< | ||
| (...args: any) => Promise<any>, | ||
| Schema | undefined, | ||
| true | undefined | ||
| >, | ||
| O extends EndpointExtendOptions<F> & | ||
| Partial<Omit<E, keyof EndpointInstance<FetchFunction>>> & | ||
| Record<string, unknown>, | ||
| >( | ||
| this: E, | ||
| options: Readonly<O>, | ||
| ): ExtendedEndpoint<typeof options, E, F>; | ||
| } | ||
|
|
||
| /** | ||
| * Defines an async data source. | ||
| * @see https://resthooks.io/docs/api/Endpoint | ||
| */ | ||
| export interface EndpointInstanceInterface< | ||
| F extends FetchFunction = FetchFunction, | ||
| S extends Schema | undefined = Schema | undefined, | ||
| M extends true | undefined = true | undefined, | ||
| > extends EndpointInterface<F, S, M> { | ||
| constructor: EndpointConstructor; | ||
|
|
||
| /** | ||
| * Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function. | ||
| * @param thisArg The object to be used as the this object. | ||
| * @param argArray A set of arguments to be passed to the function. | ||
| */ | ||
| apply<E extends FetchFunction>( | ||
| this: E, | ||
| thisArg: any, | ||
| argArray?: Parameters<E>, | ||
| ): ReturnType<E>; | ||
|
|
||
| /** | ||
| * Calls a method of an object, substituting another object for the current object. | ||
| * @param thisArg The object to be used as the current object. | ||
| * @param argArray A list of arguments to be passed to the method. | ||
| */ | ||
| call<E extends FetchFunction>( | ||
| this: E, | ||
| thisArg: any, | ||
| ...argArray: Parameters<E> | ||
| ): ReturnType<E>; | ||
|
|
||
| /** | ||
| * For a given function, creates a bound function that has the same body as the original function. | ||
| * The this object of the bound function is associated with the specified object, and has the specified initial parameters. | ||
| * @param thisArg An object to which the this keyword can refer inside the new function. | ||
| * @param argArray A list of arguments to be passed to the new function. | ||
| */ | ||
| bind<E extends FetchFunction, P extends PartialArray<Parameters<E>>>( | ||
| this: E, | ||
| thisArg: any, | ||
| ...args: readonly [...P] | ||
| ): EndpointInstance< | ||
| (...args: readonly [...RemoveArray<Parameters<E>, P>]) => ReturnType<E>, | ||
| S, | ||
| M | ||
| > & | ||
| Omit<E, keyof EndpointInstance<FetchFunction>>; | ||
|
|
||
| /** Returns a string representation of a function. */ | ||
| toString(): string; | ||
|
|
||
| prototype: any; | ||
| readonly length: number; | ||
|
|
||
| // Non-standard extensions | ||
| arguments: any; | ||
| caller: F; | ||
|
|
||
| key(...args: Parameters<F>): string; | ||
|
|
||
| readonly sideEffect: M; | ||
|
|
||
| readonly schema: S; | ||
|
|
||
| fetch: F; | ||
|
|
||
| /* utilities */ | ||
| /** @see https://resthooks.io/rest/api/Endpoint#testKey */ | ||
| testKey(key: string): boolean; | ||
|
|
||
| /** The following is for compatibility with FetchShape */ | ||
| /** @deprecated */ | ||
| readonly type: M extends undefined | ||
| ? 'read' | ||
| : IfAny<M, any, IfTypeScriptLooseNull<'read', 'mutate'>>; | ||
|
|
||
| /** @deprecated */ | ||
| getFetchKey(...args: OnlyFirst<Parameters<F>>): string; | ||
| /** @deprecated */ | ||
| options?: EndpointExtraOptions<F>; | ||
| } | ||
|
|
||
| interface EndpointConstructor { | ||
| new < | ||
| F extends ( | ||
| this: EndpointInstance<FetchFunction> & E, | ||
| params?: any, | ||
| body?: any, | ||
| ) => Promise<any>, | ||
| S extends Schema | undefined = undefined, | ||
| M extends true | undefined = undefined, | ||
| E extends Record<string, any> = {}, | ||
| >( | ||
| fetchFunction: F, | ||
| options?: EndpointOptions<F, S, M> & E, | ||
| ): EndpointInstance<F, S, M> & E; | ||
| readonly prototype: Function; | ||
| } | ||
| declare let Endpoint: EndpointConstructor; | ||
|
|
||
| export default Endpoint; | ||
|
|
||
| interface ExtendableEndpointConstructor { | ||
| new < | ||
| F extends ( | ||
| this: EndpointInstanceInterface<FetchFunction> & E, | ||
| params?: any, | ||
| body?: any, | ||
| ) => Promise<any>, | ||
| S extends Schema | undefined = undefined, | ||
| M extends true | undefined = undefined, | ||
| E extends Record<string, any> = {}, | ||
| >( | ||
| RestFetch: F, | ||
| options?: Readonly<EndpointOptions<F, S, M>> & E, | ||
| ): EndpointInstanceInterface<F, S, M> & E; | ||
| readonly prototype: Function; | ||
| } | ||
| export declare let ExtendableEndpoint: ExtendableEndpointConstructor; | ||
|
|
||
| type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N; | ||
| type IfTypeScriptLooseNull<Y, N> = 1 | undefined extends 1 ? Y : N; | ||
|
|
||
| type OnlyFirst<A extends unknown[]> = A extends [] ? [] : [A[0]]; | ||
|
|
||
| type RemoveArray<Orig extends any[], Rem extends any[]> = Rem extends [ | ||
| any, | ||
| ...infer RestRem, | ||
| ] | ||
| ? Orig extends [any, ...infer RestOrig] | ||
| ? RemoveArray<RestOrig, RestRem> | ||
| : never | ||
| : Orig; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.