Skip to content

fix(http): make HttpResponse data type generic #8511

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
medbenmakhlouf wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −11
Open

fix(http): make HttpResponse data type generic #8511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
525c6f7
fix(core): make HttpResponse data type generic
medbenmakhlouf Jun 20, 2026
462a05a
fix(docs): update HttpResponse examples to use generic type
medbenmakhlouf Jun 20, 2026
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
22 changes: 13 additions & 9 deletions core/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,11 @@ export default config;
## Example

```typescript
import { CapacitorHttp } from '@capacitor/core';
import { CapacitorHttp, type HttpResponse } from '@capacitor/core';

interface MyResponse {
foo: string;
}

// Example of a GET request
const doGet = () => {
Expand All @@ -54,7 +58,7 @@ const doGet = () => {
params: { size: 'XL' },
};

const response: HttpResponse = await CapacitorHttp.get(options);
const response: HttpResponse<MyResponse> = await CapacitorHttp.get(options);

// or...
// const response = await CapacitorHttp.request({ ...options, method: 'GET' })
Expand All @@ -69,7 +73,7 @@ const doPost = () => {
data: { foo: 'bar' },
};

const response: HttpResponse = await CapacitorHttp.post(options);
const response: HttpResponse<MyResponse> = await CapacitorHttp.post(options);

// or...
// const response = await CapacitorHttp.request({ ...options, method: 'POST' })
Expand Down Expand Up @@ -205,11 +209,11 @@ Make a Http DELETE Request to a server using native libraries.
### Interfaces


#### HttpResponse
#### HttpResponse<T = any>

| Prop | Type | Description |
| ------------- | --------------------------------------------------- | ------------------------------------------------- |
| **`data`** | <code>any</code> | Additional data received with the Http response. |
| **`data`** | <code>T</code> | Additional data received with the Http response. |
| **`status`** | <code>number</code> | The status code received from the Http response. |
| **`headers`** | <code><a href="#httpheaders">HttpHeaders</a></code> | The headers received from the Http response. |
| **`url`** | <code>string</code> | The response URL received from the Http response. |
Expand Down Expand Up @@ -279,9 +283,9 @@ https://nodejs.org/api/buffer.html#class-blob

#### ArrayBuffer

Represents a raw buffer of binary data, which is used to store data for the
different typed arrays. ArrayBuffers cannot be read from or written to directly,
but can be passed to a typed array or DataView Object to interpret the raw
Represents a raw buffer of binary data, which is used to store data for the
different typed arrays. ArrayBuffers cannot be read from or written to directly,
but can be passed to a typed array or DataView Object to interpret the raw
buffer as needed.

| Prop | Type | Description |
Expand Down Expand Up @@ -542,7 +546,7 @@ https://nodejs.org/api/url.html#class-urlsearchparams

#### Uint8Array

A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the
A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the
requested number of bytes could not be allocated an exception is raised.

| Prop | Type | Description |
Expand Down
4 changes: 2 additions & 2 deletions core/src/core-plugins.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,11 +262,11 @@ export interface HttpHeaders {
[key: string]: string;
}

export interface HttpResponse {
export interface HttpResponse<T = any> {
/**
* Additional data received with the Http response.
*/
data: any;
data: T;
/**
* The status code received from the Http response.
*/
Expand Down