Skip to content

feature: support custom hook #491

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
ysknsid25 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feature: support custom hook #491

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ export interface FetchOptions<R extends ResponseType = ResponseType, T = any>

/** Default is [408, 409, 425, 429, 500, 502, 503, 504] */
retryStatusCodes?: number[];

/** Define custom hooks */
hooks?: {
[key: string]: FetchHook<FetchContext<T, R>>;
};
}

export interface ResolvedFetchOptions<
Expand Down
100 changes: 100 additions & 0 deletions test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,4 +533,104 @@ describe("ofetch", () => {
headers: expect.any(Headers),
});
});

it("call custom hooks", async () => {
const customCommon = vi.fn();
const customOnRequest = vi.fn();
const customOnRequestError = vi.fn();
const customOnResponse = vi.fn();
const customOnResponseError = vi.fn();

const onRequest = (context) => {
context.options.hooks.customCommon();
context.options.hooks.customOnRequest(context.request);
};
const onRequestError = (context) => {
context.options.hooks.customCommon();
context.options.hooks.customOnRequestError(context.error.message);
};
const onResponse = (context) => {
context.options.hooks.customCommon();
context.options.hooks.customOnResponse(
context.response.status,
context.response.statusText
);
};
const onResponseError = (context) => {
context.options.hooks.customCommon();
context.options.hooks.customOnResponseError(
context.response.status,
context.response.statusText
);
};

await $fetch(getURL("/ok"), {
onRequest,
onRequestError,
onResponse,
onResponseError,
hooks: {
customCommon,
customOnRequest,
customOnRequestError,
customOnResponse,
customOnResponseError,
},
});

expect(customCommon).toHaveBeenCalledTimes(2);
expect(customOnRequest).toHaveBeenCalledOnce();
expect(customOnRequest).toHaveBeenCalledWith("http://localhost:3000/ok");
expect(customOnRequestError).not.toHaveBeenCalled();
expect(customOnResponse).toHaveBeenCalledOnce();
expect(customOnResponse).toHaveBeenCalledWith(200, "OK");
expect(customOnResponseError).not.toHaveBeenCalled();

customCommon.mockReset();
customOnRequest.mockReset();
customOnRequestError.mockReset();
customOnResponse.mockReset();
customOnResponseError.mockReset();

await $fetch(getURL("/403"), {
onRequest,
onRequestError,
onResponse,
onResponseError,
hooks: {
customCommon,
customOnRequest,
customOnRequestError,
customOnResponse,
customOnResponseError,
},
}).catch((error) => error);

expect(customCommon).toHaveBeenCalledTimes(3);
expect(customOnRequest).toHaveBeenCalledOnce();
expect(customOnRequest).toHaveBeenCalledWith("http://localhost:3000/403");
expect(customOnRequestError).not.toHaveBeenCalled();
expect(customOnResponse).toHaveBeenCalledOnce();
expect(customOnResponse).toHaveBeenCalledWith(403, "Forbidden");
expect(customOnResponseError).toHaveBeenCalledOnce();
expect(customOnResponseError).toHaveBeenCalledWith(403, "Forbidden");

customCommon.mockReset();
customOnRequest.mockReset();
customOnRequestError.mockReset();
customOnResponse.mockReset();
customOnResponseError.mockReset();

await $fetch("/" /* non absolute is not acceptable */, {
onRequestError,
hooks: {
customCommon,
customOnRequestError,
},
}).catch((error) => error);

expect(customOnRequestError).toHaveBeenCalledWith(
"Failed to parse URL from /"
);
});
});