Skip to content

Add interceptor indexes #2029

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.

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 9 commits into from
May 26, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fixed typos in docs
  • Loading branch information
henry-encord committed May 26, 2025
commit 960c282b42cd5fc2915c86b2c87a96f256c6c582
10 changes: 5 additions & 5 deletions docs/openapi-ts/clients/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Interceptors (middleware) can be used to modify requests before they're sent or
import { client } from 'client/client.gen';

// Supports async functions
interceptorId = client.interceptors.request.use(async (request) => {
const interceptorId = client.interceptors.request.use(async (request) => {
// do something
return request;
});
Expand Down Expand Up @@ -192,14 +192,13 @@ and an example response interceptor

::: code-group


```js [use]
import { client } from 'client/client.gen';

// Supports async functions
interceptorId = client.interceptors.response.use(async (response) => {
// do something
return request;
return response;
});
```

Expand All @@ -208,7 +207,7 @@ import { client } from 'client/client.gen';

client.interceptors.response.eject((interceptorId) => {
// do something
return request;
return response;
});
```

Expand All @@ -217,9 +216,10 @@ import { client } from 'client/client.gen';

client.interceptors.response.update(async (interceptorId, response) => {
// do something
return request;
return response;
});
```

:::

::: tip
Expand Down
10 changes: 5 additions & 5 deletions docs/openapi-ts/clients/next-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Interceptors (middleware) can be used to modify requests before they're sent or
import { client } from 'client/client.gen';

// Supports async functions
interceptorId = client.interceptors.request.use(async (request) => {
const interceptorId = client.interceptors.request.use(async (request) => {
// do something
return request;
});
Expand Down Expand Up @@ -186,14 +186,13 @@ and an example response interceptor

::: code-group


```js [use]
import { client } from 'client/client.gen';

// Supports async functions
interceptorId = client.interceptors.response.use(async (response) => {
// do something
return request;
return response;
});
```

Expand All @@ -202,7 +201,7 @@ import { client } from 'client/client.gen';

client.interceptors.response.eject((interceptorId) => {
// do something
return request;
return response;
});
```

Expand All @@ -211,9 +210,10 @@ import { client } from 'client/client.gen';

client.interceptors.response.update(async (interceptorId, response) => {
// do something
return request;
return response;
});
```

:::
::: tip
To eject, you must provide the id of the interceptor passed to `use()`, this is the value returned by `use()`.
Expand Down