-
-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor /platform HttpClient (#3537)
- Loading branch information
Showing
36 changed files
with
1,029 additions
and
1,209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
"@effect/platform-browser": minor | ||
"@effect/platform-node": minor | ||
"@effect/platform-bun": minor | ||
"@effect/platform": minor | ||
"@effect/rpc-http": minor | ||
--- | ||
|
||
refactor /platform HttpClient | ||
|
||
#### HttpClient.fetch removed | ||
|
||
The `HttpClient.fetch` client implementation has been removed. Instead, you can | ||
access a `HttpClient` using the corresponding `Context.Tag`. | ||
|
||
```ts | ||
import { FetchHttpClient, HttpClient } from "@effect/platform" | ||
import { Effect } from "effect" | ||
|
||
Effect.gen(function* () { | ||
const client = yield* HttpClient.HttpClient | ||
|
||
// make a get request | ||
yield* client.get("https://jsonplaceholder.typicode.com/todos/1") | ||
}).pipe( | ||
Effect.scoped, | ||
// the fetch client has been moved to the `FetchHttpClient` module | ||
Effect.provide(FetchHttpClient.layer) | ||
) | ||
``` | ||
|
||
#### `HttpClient` interface now uses methods | ||
|
||
Instead of being a function that returns the response, the `HttpClient` | ||
interface now uses methods to make requests. | ||
|
||
Some shorthand methods have been added to the `HttpClient` interface to make | ||
less complex requests easier. | ||
|
||
```ts | ||
import { | ||
FetchHttpClient, | ||
HttpClient, | ||
HttpClientRequest | ||
} from "@effect/platform" | ||
import { Effect } from "effect" | ||
|
||
Effect.gen(function* () { | ||
const client = yield* HttpClient.HttpClient | ||
|
||
// make a get request | ||
yield* client.get("https://jsonplaceholder.typicode.com/todos/1") | ||
// make a post request | ||
yield* client.post("https://jsonplaceholder.typicode.com/todos") | ||
|
||
// execute a request instance | ||
yield* client.execute( | ||
HttpClientRequest.get("https://jsonplaceholder.typicode.com/todos/1") | ||
) | ||
}) | ||
``` | ||
|
||
#### Scoped `HttpClientResponse` helpers removed | ||
|
||
The `HttpClientResponse` helpers that also eliminated the `Scope` have been removed. | ||
|
||
Instead, you can use the `HttpClientResponse` methods directly, and explicitly | ||
add a `Effect.scoped` to the pipeline. | ||
|
||
```ts | ||
import { FetchHttpClient, HttpClient } from "@effect/platform" | ||
import { Effect } from "effect" | ||
|
||
Effect.gen(function* () { | ||
const client = yield* HttpClient.HttpClient | ||
|
||
yield* client.get("https://jsonplaceholder.typicode.com/todos/1").pipe( | ||
Effect.flatMap((response) => response.json), | ||
Effect.scoped // eliminate the `Scope` | ||
) | ||
}) | ||
``` | ||
|
||
#### Some apis have been renamed | ||
|
||
Including the `HttpClientRequest` body apis, which is to make them more | ||
discoverable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.