Skip to content

Make the type of the parameters a generic #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
snoack wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make the type of the parameters a generic #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
export default class Hubkit {
export default class Hubkit<TParams extends Parameters = {}> {
static defaults: Options & {stats: Stats};
static Stats: StatsClass;
static readonly RETRY: unique symbol;
static readonly DONT_RETRY: unique symbol;

constructor(options?: Options);
defaultOptions: Options;
request(path: string, options?: Options): Promise<any>;
constructor(options?: Options & TParams);
defaultOptions: Options & TParams;
request(path: string, options?: Options & Parameters): Promise<any>;
graph(query: string, options?: Options & {variables?: Record<string, any>}): Promise<any>;
interpolate(string: string, options?: Record<string, any>);
scope(options: Options);
interpolate(string: string, options?: Parameters);
scope<Tsource extends Parameters>(options: Options & Tsource): Hubkit<TParams & Tsource>;
}

interface Options {
Expand Down Expand Up @@ -42,8 +42,6 @@ interface Options {
clientId?: string;
clientSecret?: string;

[key: string]: any;

onSend?(cause: 'initial' | 'retry' | 'page'): number; // returns timeout
onError?(error: Error & {
status?: number,
Expand All @@ -60,6 +58,10 @@ interface Options {
undefined | typeof Hubkit.RETRY | typeof Hubkit.DONT_RETRY | any;
}

interface Parameters {
[key: string]: any;
}

interface StatsClass {
new(): Stats;
}
Expand Down