@effect/platform 0.66.2 → 0.66.3

package/src/HttpRouter.ts

@@ -321,7 +321,15 @@ export const currentRouterConfig: FiberRef<Partial<RouterConfig>> = internal.cur
  * @category router config
  */
 export const withRouterConfig: {
+  /**
+   * @since 1.0.0
+   * @category router config
+   */
   (config: Partial<RouterConfig>): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category router config
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, config: Partial<RouterConfig>): Effect.Effect<A, E, R>
 } = internal.withRouterConfig
 
@@ -362,7 +370,15 @@ export const makeRoute: <E, R>(
  * @category utils
  */
 export const prefixPath: {
+  /**
+   * @since 1.0.0
+   * @category utils
+   */
   (prefix: string): (self: string) => string
+  /**
+   * @since 1.0.0
+   * @category utils
+   */
   (self: string, prefix: string): string
 } = internal.prefixPath
 
@@ -371,7 +387,15 @@ export const prefixPath: {
  * @category combinators
  */
 export const prefixAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (prefix: PathInput): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E, R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R>(self: HttpRouter<E, R>, prefix: PathInput): HttpRouter<E, R>
 } = internal.prefixAll
 
@@ -380,18 +404,21 @@ export const prefixAll: {
  * @category combinators
  */
 export const append: {
-  <R1, E1>(
-    route: Route<E1, R1>
-  ): <E, R>(
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  <R1, E1>(route: Route<E1, R1>): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<
     E1 | E,
     R | HttpRouter.ExcludeProvided<R1>
   >
-  <E, R, E1, R1>(
-    self: HttpRouter<E, R>,
-    route: Route<E1, R1>
-  ): HttpRouter<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  <E, R, E1, R1>(self: HttpRouter<E, R>, route: Route<E1, R1>): HttpRouter<
     E | E1,
     R | HttpRouter.ExcludeProvided<R1>
   >
@@ -402,9 +429,17 @@ export const append: {
  * @category combinators
  */
 export const concat: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <R1, E1>(that: HttpRouter<E1, R1>): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R1 | R>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, R1, E1>(self: HttpRouter<E, R>, that: HttpRouter<E1, R1>): HttpRouter<
     E | E1,
     R | R1
@@ -424,7 +459,15 @@ export const concatAll: <Routers extends ReadonlyArray<HttpRouter<unknown, unkno
  * @category routing
  */
 export const mount: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(path: `/${string}`, that: HttpRouter<E1, R1>): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E1 | E, R1 | R>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(self: HttpRouter<E, R>, path: `/${string}`, that: HttpRouter<E1, R1>): HttpRouter<E | E1, R | R1>
 } = internal.mount
 
@@ -433,6 +476,10 @@ export const mount: {
  * @category routing
  */
 export const mountApp: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: `/${string}`,
     that: App.Default<E1, R1>,
@@ -444,6 +491,10 @@ export const mountApp: {
     | HttpRouter.ExcludeProvided<R1>
     | HttpRouter.ExcludeProvided<R>
   >
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: `/${string}`,
@@ -483,6 +534,10 @@ export const route: (
  * @category routing
  */
 export const all: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -493,6 +548,10 @@ export const all: {
     E1 | E,
     R | HttpRouter.ExcludeProvided<R1>
   >
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -509,6 +568,10 @@ export const all: {
  * @category routing
  */
 export const get: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -516,6 +579,10 @@ export const get: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -529,6 +596,10 @@ export const get: {
  * @category routing
  */
 export const post: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -536,6 +607,10 @@ export const post: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -549,6 +624,10 @@ export const post: {
  * @category routing
  */
 export const patch: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -556,6 +635,10 @@ export const patch: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -569,6 +652,10 @@ export const patch: {
  * @category routing
  */
 export const put: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -576,6 +663,10 @@ export const put: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -589,6 +680,10 @@ export const put: {
  * @category routing
  */
 export const del: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -596,6 +691,10 @@ export const del: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -609,6 +708,10 @@ export const del: {
  * @category routing
  */
 export const head: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -616,6 +719,10 @@ export const head: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -629,6 +736,10 @@ export const head: {
  * @category routing
  */
 export const options: {
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <R1, E1>(
     path: PathInput,
     handler: Route.Handler<E1, R1>,
@@ -636,6 +747,10 @@ export const options: {
   ): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | E, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category routing
+   */
   <E, R, E1, R1>(
     self: HttpRouter<E, R>,
     path: PathInput,
@@ -649,9 +764,17 @@ export const options: {
  * @category combinators
  */
 export const use: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, R1, E1>(
     f: (self: Route.Middleware<E, R>) => App.Default<E1, R1>
   ): (self: HttpRouter<E, R>) => HttpRouter<E1, HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, R1, E1>(
     self: HttpRouter<E, R>,
     f: (self: Route.Middleware<E, R>) => App.Default<E1, R1>
@@ -663,9 +786,17 @@ export const use: {
  * @category combinators
  */
 export const transform: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, R1, E1>(
     f: (self: Route.Handler<E, R>) => App.HttpApp<Respondable.Respondable, E1, R1>
   ): (self: HttpRouter<E, R>) => HttpRouter<E1, HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, R1, E1>(
     self: HttpRouter<E, R>,
     f: (self: Route.Handler<E, R>) => App.HttpApp<Respondable.Respondable, E1, R1>
@@ -677,9 +808,17 @@ export const transform: {
  * @category combinators
  */
 export const catchAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, E2, R2>(
     f: (e: E) => Route.Handler<E2, R2>
   ): <R>(self: HttpRouter<E, R>) => HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpRouter<E, R>,
     f: (e: E) => Route.Handler<E2, R2>
@@ -691,9 +830,17 @@ export const catchAll: {
  * @category combinators
  */
 export const catchAllCause: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, E2, R2>(
     f: (e: Cause.Cause<E>) => Route.Handler<E2, R2>
   ): <R>(self: HttpRouter<E, R>) => HttpRouter<E2, R | HttpRouter.ExcludeProvided<R2>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, E2, R2>(
     self: HttpRouter<E, R>,
     f: (e: Cause.Cause<E>) => Route.Handler<E2, R2>
@@ -705,12 +852,20 @@ export const catchAllCause: {
  * @category combinators
  */
 export const catchTag: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <K extends E extends { _tag: string } ? E["_tag"] : never, E, E1, R1>(
     k: K,
     f: (e: Extract<E, { _tag: K }>) => Route.Handler<E1, R1>
   ): <R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<E1 | Exclude<E, { _tag: K }>, R | HttpRouter.ExcludeProvided<R1>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, K extends E extends { _tag: string } ? E["_tag"] : never, E1, R1>(
     self: HttpRouter<E, R>,
     k: K,
@@ -723,14 +878,16 @@ export const catchTag: {
  * @category combinators
  */
 export const catchTags: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <
     E,
     Cases extends E extends { _tag: string }
       ? { [K in E["_tag"]]+?: ((error: Extract<E, { _tag: K }>) => Route.Handler<any, any>) | undefined }
       : {}
-  >(
-    cases: Cases
-  ): <R>(
+  >(cases: Cases): <R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<
     | Exclude<E, { _tag: keyof Cases }>
@@ -744,16 +901,17 @@ export const catchTags: {
       }[keyof Cases]
     >
   >
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <
     R,
     E,
     Cases extends E extends { _tag: string }
       ? { [K in E["_tag"]]+?: ((error: Extract<E, { _tag: K }>) => Route.Handler<any, any>) | undefined } :
       {}
-  >(
-    self: HttpRouter<E, R>,
-    cases: Cases
-  ): HttpRouter<
+  >(self: HttpRouter<E, R>, cases: Cases): HttpRouter<
     | Exclude<E, { _tag: keyof Cases }>
     | {
       [K in keyof Cases]: Cases[K] extends (...args: Array<any>) => Effect.Effect<any, infer E, any> ? E : never
@@ -772,10 +930,18 @@ export const catchTags: {
  * @category combinators
  */
 export const provideService: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <T extends Context.Tag<any, any>>(
     tag: T,
     service: Context.Tag.Service<T>
   ): <E, R>(self: HttpRouter<E, R>) => HttpRouter<E, Exclude<R, Context.Tag.Identifier<T>>>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, T extends Context.Tag<any, any>>(
     self: HttpRouter<E, R>,
     tag: T,
@@ -788,16 +954,21 @@ export const provideService: {
  * @category combinators
  */
 export const provideServiceEffect: {
-  <T extends Context.Tag<any, any>, R1, E1>(
-    tag: T,
-    effect: Effect.Effect<Context.Tag.Service<T>, E1, R1>
-  ): <E, R>(
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  <T extends Context.Tag<any, any>, R1, E1>(tag: T, effect: Effect.Effect<Context.Tag.Service<T>, E1, R1>): <E, R>(
     self: HttpRouter<E, R>
   ) => HttpRouter<
     E1 | E,
     | Exclude<R, Context.Tag.Identifier<T>>
     | Exclude<HttpRouter.ExcludeProvided<R1>, Context.Tag.Identifier<T>>
   >
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <E, R, T extends Context.Tag<any, any>, R1, E1>(
     self: HttpRouter<E, R>,
     tag: T,

package/src/HttpServer.ts

@@ -105,21 +105,35 @@ export const make: (
  * @category accessors
  */
 export const serve: {
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   (): <E, R>(
     httpApp: App.Default<E, R>
   ) => Layer.Layer<never, never, HttpServer | Exclude<R, ServerRequest.HttpServerRequest | Scope.Scope>>
-  <E, R, App extends App.Default<any, any>>(
-    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
-  ): (
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
+  <E, R, App extends App.Default<any, any>>(middleware: Middleware.HttpMiddleware.Applied<App, E, R>): (
     httpApp: App.Default<E, R>
   ) => Layer.Layer<
     never,
     never,
     HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest | Scope.Scope>
   >
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   <E, R>(
     httpApp: App.Default<E, R>
   ): Layer.Layer<never, never, HttpServer | Exclude<R, ServerRequest.HttpServerRequest | Scope.Scope>>
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   <E, R, App extends App.Default<any, any>>(
     httpApp: App.Default<E, R>,
     middleware: Middleware.HttpMiddleware.Applied<App, E, R>
@@ -135,21 +149,35 @@ export const serve: {
  * @category accessors
  */
 export const serveEffect: {
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   (): <E, R>(
     httpApp: App.Default<E, R>
   ) => Effect.Effect<void, never, Scope.Scope | HttpServer | Exclude<R, ServerRequest.HttpServerRequest>>
-  <E, R, App extends App.Default<any, any>>(
-    middleware: Middleware.HttpMiddleware.Applied<App, E, R>
-  ): (
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
+  <E, R, App extends App.Default<any, any>>(middleware: Middleware.HttpMiddleware.Applied<App, E, R>): (
     httpApp: App.Default<E, R>
   ) => Effect.Effect<
     void,
     never,
     Scope.Scope | HttpServer | Exclude<Effect.Effect.Context<App>, ServerRequest.HttpServerRequest>
   >
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   <E, R>(
     httpApp: App.Default<E, R>
   ): Effect.Effect<void, never, Scope.Scope | HttpServer | Exclude<R, ServerRequest.HttpServerRequest>>
+  /**
+   * @since 1.0.0
+   * @category accessors
+   */
   <E, R, App extends App.Default<any, any>>(
     httpApp: App.Default<E, R>,
     middleware: Middleware.HttpMiddleware.Applied<App, E, R>