fx-fetch 1.0.0 → 1.0.1

package/dist/Fetch/fetchBlob.d.ts

@@ -6,5 +6,29 @@ import * as Response from "../Response/index.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readBlob}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedBlobError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Blob
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchBlob(request);
+ * });
+ * ```
  */
 export declare const fetchBlob: (request: Request.Request) => Effect.Effect<Blob, import("../Cause").MalformedBlobError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;

package/dist/Fetch/fetchBlob.js

@@ -6,6 +6,30 @@ import { fetch } from "./fetchFn.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readBlob}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedBlobError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Blob
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchBlob(request);
+ * });
+ * ```
  */
 export const fetchBlob = (request) => fetch(request).pipe(Effect.flatMap(Response.readBlob));
 //# sourceMappingURL=fetchBlob.js.map

package/dist/Fetch/fetchBlob.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchBlob.js","sourceRoot":"","sources":["../../src/Fetch/fetchBlob.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAwB,EAAE,EAAE,CACpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchBlob.js","sourceRoot":"","sources":["../../src/Fetch/fetchBlob.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAwB,EAAE,EAAE,CACpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC"}

package/dist/Fetch/fetchBytes.d.ts

@@ -6,5 +6,29 @@ import * as Response from "../Response/index.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readBytes}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedBytesError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Uint8Array<ArrayBuffer>
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchBytes(request);
+ * });
+ * ```
  */
-export declare const fetchBytes: (request: Request.Request) => Effect.Effect<ArrayBuffer, import("../Cause").MalformedBytesError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;
+export declare const fetchBytes: (request: Request.Request) => Effect.Effect<Uint8Array<ArrayBuffer>, import("../Cause").MalformedBytesError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;

package/dist/Fetch/fetchBytes.js

@@ -6,6 +6,30 @@ import { fetch } from "./fetchFn.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readBytes}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedBytesError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Uint8Array<ArrayBuffer>
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchBytes(request);
+ * });
+ * ```
  */
 export const fetchBytes = (request) => fetch(request).pipe(Effect.flatMap(Response.readBytes));
 //# sourceMappingURL=fetchBytes.js.map

package/dist/Fetch/fetchBytes.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchBytes.js","sourceRoot":"","sources":["../../src/Fetch/fetchBytes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAwB,EAAE,EAAE,CACrD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchBytes.js","sourceRoot":"","sources":["../../src/Fetch/fetchBytes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAwB,EAAE,EAAE,CACrD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC"}

package/dist/Fetch/fetchFn.d.ts

@@ -4,5 +4,33 @@ import { Fetch } from "./Fetch.js";
 /**
  * @category Functions
  * @since 0.1.0
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Response.Response
+ *   //       ▼
+ *   const response = yield* Fetch.fetch(request);
+ * });
+ *
+ * // Run the program
+ * program.pipe(
+ *   Effect.provideService(Fetch.Fetch, Fetch.FetchLive),
+ *   Effect.runFork // or Effect.runPromise etc.
+ * );
+ * ```
  */
 export declare const fetch: (request: Request.Request) => Effect.Effect<import("../Response").Response, import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | import("../Response").NotOkError, Fetch>;

package/dist/Fetch/fetchFn.js

@@ -3,6 +3,34 @@ import { Fetch } from "./Fetch.js";
 /**
  * @category Functions
  * @since 0.1.0
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── Response.Response
+ *   //       ▼
+ *   const response = yield* Fetch.fetch(request);
+ * });
+ *
+ * // Run the program
+ * program.pipe(
+ *   Effect.provideService(Fetch.Fetch, Fetch.FetchLive),
+ *   Effect.runFork // or Effect.runPromise etc.
+ * );
+ * ```
  */
 export const fetch = Effect.fnUntraced(function* (request) {
     const fetchFn = yield* Fetch;

package/dist/Fetch/fetchFn.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchFn.js","sourceRoot":"","sources":["../../src/Fetch/fetchFn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAE,mBAAgB;AAEhC;;;GAGG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,OAAwB;IACxE,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC;IAC7B,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchFn.js","sourceRoot":"","sources":["../../src/Fetch/fetchFn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAE,mBAAgB;AAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,OAAwB;IACxE,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC;IAC7B,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC"}

package/dist/Fetch/fetchFormData.d.ts

@@ -6,5 +6,29 @@ import * as Response from "../Response/index.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readFormData}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedFormDataError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── FormData
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchFormData(request);
+ * });
+ * ```
  */
 export declare const fetchFormData: (request: Request.Request) => Effect.Effect<FormData, import("../Cause").MalformedFormDataError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;

package/dist/Fetch/fetchFormData.js

@@ -6,6 +6,30 @@ import { fetch } from "./fetchFn.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readFormData}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedFormDataError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── FormData
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchFormData(request);
+ * });
+ * ```
  */
 export const fetchFormData = (request) => fetch(request).pipe(Effect.flatMap(Response.readFormData));
 //# sourceMappingURL=fetchFormData.js.map

package/dist/Fetch/fetchFormData.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchFormData.js","sourceRoot":"","sources":["../../src/Fetch/fetchFormData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,OAAwB,EAAE,EAAE,CACxD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchFormData.js","sourceRoot":"","sources":["../../src/Fetch/fetchFormData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,OAAwB,EAAE,EAAE,CACxD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC"}

package/dist/Fetch/fetchJson.d.ts

@@ -6,5 +6,29 @@ import * as Response from "../Response/index.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readJson}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedJsonError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── unknown
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchJson(request);
+ * });
+ * ```
  */
 export declare const fetchJson: (request: Request.Request) => Effect.Effect<unknown, import("../Cause").MalformedJsonError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;

package/dist/Fetch/fetchJson.js

@@ -6,6 +6,30 @@ import { fetch } from "./fetchFn.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readJson}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedJsonError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── unknown
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchJson(request);
+ * });
+ * ```
  */
 export const fetchJson = (request) => fetch(request).pipe(Effect.flatMap(Response.readJson));
 //# sourceMappingURL=fetchJson.js.map

package/dist/Fetch/fetchJson.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchJson.js","sourceRoot":"","sources":["../../src/Fetch/fetchJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAwB,EAAE,EAAE,CACpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchJson.js","sourceRoot":"","sources":["../../src/Fetch/fetchJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAAwB,EAAE,EAAE,CACpD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC"}

package/dist/Fetch/fetchJsonWithSchema.d.ts

@@ -9,6 +9,36 @@ import { Fetch } from "./Fetch.js";
  *
  * @category Conversions
  * @since 0.1.0
+ * @see {@link Response.readJsonWithSchema}
+ * @example
+ * ```ts
+ * import { Effect, Schema } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * const UserSchema = Schema.Struct({
+ *   id: Schema.Int,
+ *   name: Schema.String,
+ * });
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedJsonError
+ * //       │      | ParseError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── typeof UserSchema.Type
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
+ * });
+ * ```
  */
 export declare const fetchJsonWithSchema: {
     /**
@@ -16,6 +46,36 @@ export declare const fetchJsonWithSchema: {
      *
      * @category Conversions
      * @since 0.1.0
+     * @see {@link Response.readJsonWithSchema}
+     * @example
+     * ```ts
+     * import { Effect, Schema } from 'effect';
+     * import { Fetch, Request, Response } from 'fx-fetch';
+     *
+     * const UserSchema = Schema.Struct({
+     *   id: Schema.Int,
+     *   name: Schema.String,
+     * });
+     *
+     * //       ┌─── Effect.Effect<
+     * //       │      void,
+     * //       │      | Fetch.FetchError
+     * //       │      | Fetch.AbortError
+     * //       │      | Fetch.NotAllowedError
+     * //       │      | Response.NotOkError
+     * //       │      | MalformedJsonError
+     * //       │      | ParseError,
+     * //       │      Fetch.Fetch
+     * //       │    >
+     * //       ▼
+     * const program = Effect.gen(function* () {
+     *   const request = Request.unsafeMake({ url: './my-endpoint' });
+     *
+     *   //       ┌─── typeof UserSchema.Type
+     *   //       ▼
+     *   const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
+     * });
+     * ```
      */
     <A, I, R>(request: Request.Request, schema: Schema.Schema<A, I, R>): Effect.Effect<A, AbortError | FetchError | NotAllowedError | Response.NotOkError | Cause.MalformedJsonError | ParseResult.ParseError, R | Fetch>;
     /**
@@ -23,6 +83,36 @@ export declare const fetchJsonWithSchema: {
      *
      * @category Conversions
      * @since 0.1.0
+     * @see {@link Response.readJsonWithSchema}
+     * @example
+     * ```ts
+     * import { Effect, Schema } from 'effect';
+     * import { Fetch, Request, Response } from 'fx-fetch';
+     *
+     * const UserSchema = Schema.Struct({
+     *   id: Schema.Int,
+     *   name: Schema.String,
+     * });
+     *
+     * //       ┌─── Effect.Effect<
+     * //       │      void,
+     * //       │      | Fetch.FetchError
+     * //       │      | Fetch.AbortError
+     * //       │      | Fetch.NotAllowedError
+     * //       │      | Response.NotOkError
+     * //       │      | MalformedJsonError
+     * //       │      | ParseError,
+     * //       │      Fetch.Fetch
+     * //       │    >
+     * //       ▼
+     * const program = Effect.gen(function* () {
+     *   const request = Request.unsafeMake({ url: './my-endpoint' });
+     *
+     *   //       ┌─── typeof UserSchema.Type
+     *   //       ▼
+     *   const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
+     * });
+     * ```
      */
     <A, I, R>(schema: Schema.Schema<A, I, R>): (request: Request.Request) => Effect.Effect<A, AbortError | FetchError | NotAllowedError | Response.NotOkError | Cause.MalformedJsonError | ParseResult.ParseError, R | Fetch>;
 };

package/dist/Fetch/fetchJsonWithSchema.js

@@ -8,6 +8,36 @@ const fetchJsonWithSchemaFn = (request, schema) => fetch(request).pipe(Effect.fl
  *
  * @category Conversions
  * @since 0.1.0
+ * @see {@link Response.readJsonWithSchema}
+ * @example
+ * ```ts
+ * import { Effect, Schema } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * const UserSchema = Schema.Struct({
+ *   id: Schema.Int,
+ *   name: Schema.String,
+ * });
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedJsonError
+ * //       │      | ParseError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── typeof UserSchema.Type
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchJsonWithSchema(request, UserSchema);
+ * });
+ * ```
  */
 export const fetchJsonWithSchema = dual(2, fetchJsonWithSchemaFn);
 //# sourceMappingURL=fetchJsonWithSchema.js.map

package/dist/Fetch/fetchJsonWithSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchJsonWithSchema.js","sourceRoot":"","sources":["../../src/Fetch/fetchJsonWithSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAuB,MAAM,QAAQ,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAGvC,OAAO,KAAK,QAAQ,6BAAoB;AAGxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC,MAAM,qBAAqB,GAAG,CAAU,OAAwB,EAAE,MAA8B,EAAE,EAAE,CAClG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAyC5B,IAAI,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"fetchJsonWithSchema.js","sourceRoot":"","sources":["../../src/Fetch/fetchJsonWithSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAuB,MAAM,QAAQ,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAGvC,OAAO,KAAK,QAAQ,6BAAoB;AAGxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC,MAAM,qBAAqB,GAAG,CAAU,OAAwB,EAAE,MAA8B,EAAE,EAAE,CAClG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAqG5B,IAAI,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC"}

package/dist/Fetch/fetchReadableStream.d.ts

@@ -6,5 +6,29 @@ import * as Response from "../Response/index.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readReadableStream}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedReadableStreamError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── ReadableStream<Uint8Array<ArrayBuffer>>
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchReadableStream(request);
+ * });
+ * ```
  */
 export declare const fetchReadableStream: (request: Request.Request) => Effect.Effect<ReadableStream<Uint8Array<ArrayBuffer>>, import("../Cause").MalformedReadableStreamError | import("./errors").FetchError | import("./errors").AbortError | import("./errors").NotAllowedError | Response.NotOkError, import("./Fetch").Fetch>;

package/dist/Fetch/fetchReadableStream.js

@@ -6,6 +6,30 @@ import { fetch } from "./fetchFn.js";
  *
  * @category Functions
  * @since 0.1.0
+ * @see {@link Response.readReadableStream}
+ * @example
+ * ```ts
+ * import { Effect } from 'effect';
+ * import { Fetch, Request, Response } from 'fx-fetch';
+ *
+ * //       ┌─── Effect.Effect<
+ * //       │      void,
+ * //       │      | Fetch.FetchError
+ * //       │      | Fetch.AbortError
+ * //       │      | Fetch.NotAllowedError
+ * //       │      | Response.NotOkError
+ * //       │      | MalformedReadableStreamError,
+ * //       │      Fetch.Fetch
+ * //       │    >
+ * //       ▼
+ * const program = Effect.gen(function* () {
+ *   const request = Request.unsafeMake({ url: './my-endpoint' });
+ *
+ *   //       ┌─── ReadableStream<Uint8Array<ArrayBuffer>>
+ *   //       ▼
+ *   const payload = yield* Fetch.fetchReadableStream(request);
+ * });
+ * ```
  */
 export const fetchReadableStream = (request) => fetch(request).pipe(Effect.flatMap(Response.readReadableStream));
 //# sourceMappingURL=fetchReadableStream.js.map

package/dist/Fetch/fetchReadableStream.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetchReadableStream.js","sourceRoot":"","sources":["../../src/Fetch/fetchReadableStream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC9D,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"fetchReadableStream.js","sourceRoot":"","sources":["../../src/Fetch/fetchReadableStream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,KAAK,QAAQ,6BAAoB;AACxC,OAAO,EAAE,KAAK,EAAE,qBAAkB;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC9D,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC"}