refactor: rename http status code type

joshamaju · Jul 16, 2024 · a9b8769 · a9b8769
1 parent fd6589c
commit a9b8769
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 14 deletions.
diff --git a/.changeset/many-ravens-burn.md b/.changeset/many-ravens-burn.md
@@ -0,0 +1,5 @@
+---
+"effect-fetch": minor
+---
+
+Rename the Typescript type for exported HTTP status codes
diff --git a/example/index.ts b/example/index.ts
@@ -16,7 +16,7 @@ const program = Effect.gen(function* () {
   console.log(users);
 });
 
-const matchOk = Match.type<Result.OkStatusCode>().pipe(
+const matchOk = Match.type<Result.StatusOK>().pipe(
   Match.when(200, () => "200"),
   Match.when(201, () => "201"),
   Match.when(202, () => "202"),
@@ -38,7 +38,7 @@ const matchNotOk = Match.type<Response>().pipe(
 
 const status = Fetch.fetch("/users/2").pipe(
   Effect.andThen(Result.filterStatusOk),
-  Effect.andThen((res) => matchOk(res.status as Result.OkStatusCode)),
+  Effect.andThen((res) => matchOk(res.status as Result.StatusOK)),
   Effect.catchTag('StatusError', res => Effect.succeed(matchNotOk(res.response))),
   Effect.andThen(Effect.log),
   Effect.catchAll(Effect.log),

diff --git a/src/Response.ts b/src/Response.ts
@@ -12,7 +12,7 @@ import {
   StatusError,
   StatusErrorT,
 } from "./internal/response/index.js";
-import { NotOkStatusCode, OkStatusCode } from "./internal/response/types.js";
+import { StatusNotOK, StatusOK } from "./internal/response/types.js";
 
 export {
   /**
@@ -22,16 +22,16 @@ export {
   StatusCode,
 
   /**
-   * @since 1.1.0
+   * @since 2.1.0
    * @category status code
    */
-  OkStatusCode,
+  StatusOK,
 
   /**
-   * @since 1.1.0
+   * @since 2.1.0
    * @category status code
    */
-  NotOkStatusCode,
+  StatusNotOK,
 } from "./internal/response/types.js";
 
 export {
@@ -99,7 +99,7 @@ export const filterStatusOk: (
  */
 export const filterStatusOkT: (
   response: Response
-) => Effect<ResponseT<OkStatusCode>, StatusErrorT<NotOkStatusCode>, never> =
+) => Effect<ResponseT<StatusOK>, StatusErrorT<StatusNotOK>, never> =
   internal.filterStatusOkT;
 
 /**

diff --git a/src/internal/response/index.ts b/src/internal/response/index.ts
@@ -4,7 +4,7 @@ import type { Predicate } from "effect/Predicate";
 
 import { DecodeError } from "../error.js";
 import { decode } from "../utils.js";
-import { NotOkStatusCode, OkStatusCode, StatusCode } from "./types.js";
+import { StatusNotOK, StatusOK, StatusCode } from "./types.js";
 
 export class StatusError {
   readonly _tag = "StatusError";
@@ -41,8 +41,8 @@ export interface ResponseT<S extends StatusCode> extends Response {
 export const filterStatusOkT = flow(
   filterStatusOk,
   Effect.mapBoth({
-    onSuccess: (r) => r as ResponseT<OkStatusCode>,
-    onFailure: (e) => e as StatusErrorT<NotOkStatusCode>,
+    onSuccess: (r) => r as ResponseT<StatusOK>,
+    onFailure: (e) => e as StatusErrorT<StatusNotOK>,
   })
 );
 

diff --git a/src/internal/response/types.ts b/src/internal/response/types.ts
@@ -1,4 +1,4 @@
-export type OkStatusCode =
+export type StatusOK =
   | 200 // OK
   | 201 // Created
   | 202 // Accepted
@@ -15,7 +15,7 @@ export type StatusCode =
   | 101 // Switching Protocols
   | 102 // Processing
   | 103 // Early Hints
-  | OkStatusCode
+  | StatusOK
   | 300 // Multiple Choices
   | 301 // Moved Permanently
   | 302 // Found
@@ -66,4 +66,4 @@ export type StatusCode =
   | 510 // Not Extended
   | 511; // Network Authentication Required
 
-  export type NotOkStatusCode = Exclude<StatusCode, OkStatusCode>
+  export type StatusNotOK = Exclude<StatusCode, StatusOK>