fixed search params related function signatures (#3339)

Effect-TS · Jul 25, 2024 · eb4d014 · eb4d014
1 parent 1c4176c
commit eb4d014
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 8 deletions.
diff --git a/.changeset/bright-shirts-love.md b/.changeset/bright-shirts-love.md
@@ -0,0 +1,5 @@
+---
+"@effect/platform": patch
+---
+
+Fixed various search params related function signatures (`Array => ReadonlyArray`)
diff --git a/packages/platform/src/HttpRouter.ts b/packages/platform/src/HttpRouter.ts
@@ -250,7 +250,7 @@ export const schemaJson: <
     readonly cookies: Readonly<Record<string, string | undefined>>
     readonly headers: Readonly<Record<string, string | undefined>>
     readonly pathParams: Readonly<Record<string, string | undefined>>
-    readonly searchParams: Readonly<Record<string, string | Array<string> | undefined>>
+    readonly searchParams: Readonly<Record<string, string | ReadonlyArray<string> | undefined>>
     readonly body: any
   }>,
   A
@@ -276,7 +276,7 @@ export const schemaNoBody: <
       readonly cookies: Readonly<Record<string, string | undefined>>
       readonly headers: Readonly<Record<string, string | undefined>>
       readonly pathParams: Readonly<Record<string, string | undefined>>
-      readonly searchParams: Readonly<Record<string, string | Array<string> | undefined>>
+      readonly searchParams: Readonly<Record<string, string | ReadonlyArray<string> | undefined>>
     }
   >,
   A
@@ -293,7 +293,7 @@ export const schemaNoBody: <
  * @since 1.0.0
  * @category route context
  */
-export const schemaParams: <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
+export const schemaParams: <A, I extends Readonly<Record<string, string | ReadonlyArray<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, R | RouteContext | ServerRequest.ParsedSearchParams> =

diff --git a/packages/platform/src/HttpServerRequest.ts b/packages/platform/src/HttpServerRequest.ts
@@ -152,7 +152,7 @@ export const schemaHeaders: <A, I extends Readonly<Record<string, string | undef
  * @since 1.0.0
  * @category schema
  */
-export const schemaSearchParams: <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
+export const schemaSearchParams: <A, I extends Readonly<Record<string, string | ReadonlyArray<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => Effect.Effect<A, ParseResult.ParseError, ParsedSearchParams | R> = internal.schemaSearchParams

diff --git a/packages/platform/src/internal/httpRouter.ts b/packages/platform/src/internal/httpRouter.ts
@@ -50,7 +50,7 @@ export const schemaJson = <
     readonly cookies: Readonly<Record<string, string | undefined>>
     readonly headers: Readonly<Record<string, string | undefined>>
     readonly pathParams: Readonly<Record<string, string | undefined>>
-    readonly searchParams: Readonly<Record<string, string | Array<string> | undefined>>
+    readonly searchParams: Readonly<Record<string, string | ReadonlyArray<string> | undefined>>
     readonly body: any
   }>,
   A
@@ -88,7 +88,7 @@ export const schemaNoBody = <
     readonly cookies: Readonly<Record<string, string | undefined>>
     readonly headers: Readonly<Record<string, string | undefined>>
     readonly pathParams: Readonly<Record<string, string | undefined>>
-    readonly searchParams: Readonly<Record<string, string | Array<string> | undefined>>
+    readonly searchParams: Readonly<Record<string, string | ReadonlyArray<string> | undefined>>
   }>,
   A
 >(
@@ -115,7 +115,7 @@ export const schemaNoBody = <
 }
 
 /** @internal */
-export const schemaParams = <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
+export const schemaParams = <A, I extends Readonly<Record<string, string | ReadonlyArray<string> | undefined>>, R>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {

diff --git a/packages/platform/src/internal/httpServerRequest.ts b/packages/platform/src/internal/httpServerRequest.ts
@@ -81,7 +81,11 @@ export const schemaHeaders = <A, I extends Readonly<Record<string, string | unde
 }
 
 /** @internal */
-export const schemaSearchParams = <A, I extends Readonly<Record<string, string | Array<string> | undefined>>, R>(
+export const schemaSearchParams = <
+  A,
+  I extends Readonly<Record<string, string | ReadonlyArray<string> | undefined>>,
+  R
+>(
   schema: Schema.Schema<A, I, R>,
   options?: ParseOptions | undefined
 ) => {