-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d114251
commit bc5c791
Showing
17 changed files
with
1,033 additions
and
11 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
remote_theme: mikearnaldi/just-the-docs | ||
|
||
# Enable or disable the site search | ||
search_enabled: true | ||
|
||
# Aux links for the upper right navigation | ||
aux_links: | ||
'effect-fetch on GitHub': | ||
- 'https://github.com/joshamaju/effect-fetch' |
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,4 @@ | ||
--- | ||
title: Home | ||
nav_order: 1 | ||
--- |
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,30 @@ | ||
--- | ||
title: Adapters/Fetch.ts | ||
nav_order: 1 | ||
parent: Modules | ||
--- | ||
|
||
## Fetch overview | ||
|
||
Added in v1.0.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [adapter](#adapter) | ||
- [fetch](#fetch) | ||
|
||
--- | ||
|
||
# adapter | ||
|
||
## fetch | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const fetch: Adapter | ||
``` | ||
Added in v1.0.0 |
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,185 @@ | ||
--- | ||
title: Client.ts | ||
nav_order: 2 | ||
parent: Modules | ||
--- | ||
|
||
## Client overview | ||
|
||
Added in v1.3.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [constructor](#constructor) | ||
- [create](#create) | ||
- [delete](#delete) | ||
- [get](#get) | ||
- [head](#head) | ||
- [layer](#layer) | ||
- [make](#make) | ||
- [options](#options) | ||
- [patch](#patch) | ||
- [post](#post) | ||
- [put](#put) | ||
- [model](#model) | ||
- [Handlers (interface)](#handlers-interface) | ||
- [tag](#tag) | ||
- [Client (class)](#client-class) | ||
|
||
--- | ||
|
||
# constructor | ||
|
||
## create | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const create: <E = never, R = never>( | ||
config: Config<E, R> | ||
) => Effect<Handlers, HttpError | E, Exclude<Exclude<R, Context>, Fetch>> | ||
``` | ||
Added in v1.4.0 | ||
## delete | ||
**Signature** | ||
```ts | ||
export declare const delete: (url: string | URL | HttpRequest, init?: RequestInit | undefined) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## get | ||
**Signature** | ||
```ts | ||
export declare const get: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## head | ||
**Signature** | ||
```ts | ||
export declare const head: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## layer | ||
**Signature** | ||
```ts | ||
export declare const layer: Layer<Client, never, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## make | ||
**Signature** | ||
```ts | ||
export declare const make: Effect<Handlers, never, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## options | ||
**Signature** | ||
```ts | ||
export declare const options: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## patch | ||
**Signature** | ||
```ts | ||
export declare const patch: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## post | ||
**Signature** | ||
```ts | ||
export declare const post: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
## put | ||
**Signature** | ||
```ts | ||
export declare const put: ( | ||
url: string | URL | HttpRequest, | ||
init?: RequestInit | undefined | ||
) => Effect<Response, StatusError | HttpError, Fetch> | ||
``` | ||
Added in v1.3.0 | ||
# model | ||
## Handlers (interface) | ||
**Signature** | ||
```ts | ||
export interface Handlers { | ||
put: Handler | ||
get: Handler | ||
head: Handler | ||
post: Handler | ||
patch: Handler | ||
delete: Handler | ||
options: Handler | ||
} | ||
``` | ||
|
||
Added in v1.3.0 | ||
|
||
# tag | ||
|
||
## Client (class) | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare class Client | ||
``` | ||
|
||
Added in v1.3.0 |
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,63 @@ | ||
--- | ||
title: Error.ts | ||
nav_order: 3 | ||
parent: Modules | ||
--- | ||
|
||
## Error overview | ||
|
||
Added in v1.1.0 | ||
|
||
--- | ||
|
||
<h2 class="text-delta">Table of contents</h2> | ||
|
||
- [error](#error) | ||
- [DecodeError](#decodeerror) | ||
- [HttpError](#httperror) | ||
- [StatusError](#statuserror) | ||
- [StatusErrorT](#statuserrort) | ||
|
||
--- | ||
|
||
# error | ||
|
||
## DecodeError | ||
|
||
**Signature** | ||
|
||
```ts | ||
export declare const DecodeError: typeof DecodeError | ||
``` | ||
Added in v1.1.0 | ||
## HttpError | ||
**Signature** | ||
```ts | ||
export declare const HttpError: typeof HttpError | ||
``` | ||
Added in v1.1.0 | ||
## StatusError | ||
**Signature** | ||
```ts | ||
export declare const StatusError: typeof StatusError | ||
``` | ||
Added in v1.1.0 | ||
## StatusErrorT | ||
**Signature** | ||
```ts | ||
export declare const StatusErrorT: any | ||
``` | ||
Added in v1.1.0 |
Oops, something went wrong.