Skip to content

fix(typescript): improve internal MapFunction type #285

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

Merged
merged 1 commit into from
Mar 11, 2021
Merged

fix(typescript): improve internal MapFunction type #285

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
74 changes: 27 additions & 47 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ type NormalizeResponse<T> = T & { data: GetResultsType<T> };

type DataType<T> = "data" extends keyof T ? T["data"] : unknown;

export interface MapFunction<T = unknown, R = unknown> {
(
response: OctokitTypes.OctokitResponse<PaginationResults<T>>,
done: () => void
): R[];
export interface MapFunction<
T = OctokitTypes.OctokitResponse<PaginationResults<unknown>>,
R = unknown[]
> {
(response: T, done: () => void): R;
}

export type PaginationResults<T = unknown> = T[];
Expand All @@ -74,7 +74,7 @@ export interface PaginateInterface {
*/
<T, R>(
options: OctokitTypes.EndpointOptions,
mapFn: MapFunction<T, R>
mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, R[]>
): Promise<PaginationResults<R>>;

/**
Expand All @@ -94,10 +94,7 @@ export interface PaginateInterface {
*/
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(
route: R,
mapFn: (
response: PaginatingEndpoints[R]["response"],
done: () => void
) => MR
mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>
): Promise<MR>;

/**
Expand All @@ -110,10 +107,7 @@ export interface PaginateInterface {
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(
route: R,
parameters: PaginatingEndpoints[R]["parameters"],
mapFn: (
response: PaginatingEndpoints[R]["response"],
done: () => void
) => MR
mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>
): Promise<MR>;

/**
Expand Down Expand Up @@ -159,12 +153,10 @@ export interface PaginateInterface {
*/
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(
request: R,
mapFn: (
response: NormalizeResponse<
OctokitTypes.GetResponseTypeFromEndpointMethod<R>
>,
done: () => void
) => MR
mapFn: MapFunction<
NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>,
MR
>
): Promise<MR>;

/**
Expand All @@ -177,12 +169,10 @@ export interface PaginateInterface {
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(
request: R,
parameters: Parameters<R>[0],
mapFn: (
response: NormalizeResponse<
OctokitTypes.GetResponseTypeFromEndpointMethod<R>
>,
done: () => void
) => MR
mapFn: MapFunction<
NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>,
MR
>
): Promise<MR>;

/**
Expand Down Expand Up @@ -276,7 +266,7 @@ export interface ComposePaginateInterface {
<T, R>(
octokit: Octokit,
options: OctokitTypes.EndpointOptions,
mapFn: MapFunction<T, R>
mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, R[]>
): Promise<PaginationResults<R>>;

/**
Expand All @@ -301,10 +291,7 @@ export interface ComposePaginateInterface {
<R extends keyof PaginatingEndpoints, MR extends unknown[]>(
octokit: Octokit,
route: R,
mapFn: (
response: PaginatingEndpoints[R]["response"],
done: () => void
) => MR
mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>
): Promise<MR>;

/**
Expand All @@ -319,10 +306,7 @@ export interface ComposePaginateInterface {
octokit: Octokit,
route: R,
parameters: PaginatingEndpoints[R]["parameters"],
mapFn: (
response: PaginatingEndpoints[R]["response"],
done: () => void
) => MR
mapFn: MapFunction<PaginatingEndpoints[R]["response"], MR>
): Promise<MR>;

/**
Expand Down Expand Up @@ -374,12 +358,10 @@ export interface ComposePaginateInterface {
<R extends OctokitTypes.RequestInterface, MR extends unknown[]>(
octokit: Octokit,
request: R,
mapFn: (
response: NormalizeResponse<
OctokitTypes.GetResponseTypeFromEndpointMethod<R>
>,
done: () => void
) => MR
mapFn: MapFunction<
NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>,
MR
>
): Promise<MR>;

/**
Expand All @@ -394,12 +376,10 @@ export interface ComposePaginateInterface {
octokit: Octokit,
request: R,
parameters: Parameters<R>[0],
mapFn: (
response: NormalizeResponse<
OctokitTypes.GetResponseTypeFromEndpointMethod<R>
>,
done: () => void
) => MR
mapFn: MapFunction<
NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>,
MR
>
): Promise<MR>;

/**
Expand Down