@effect/platform 0.66.2 → 0.66.3

package/src/HttpApiGroup.ts

@@ -175,21 +175,30 @@ export const make = <Name extends string>(identifier: Name): HttpApiGroup<Name>
  * @category endpoints
  */
 export const add: {
+  /**
+   * Add an `HttpApiEndpoint` to an `HttpApiGroup`.
+   *
+   * @since 1.0.0
+   * @category endpoints
+   */
   <A extends HttpApiEndpoint.HttpApiEndpoint.All>(
     endpoint: A
   ): <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR>(
     self: HttpApiGroup<Name, Endpoints, Error, ErrorR>
   ) => HttpApiGroup<Name, Endpoints | A, Error, ErrorR>
+  /**
+   * Add an `HttpApiEndpoint` to an `HttpApiGroup`.
+   *
+   * @since 1.0.0
+   * @category endpoints
+   */
   <
     Name extends string,
     Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All,
     Error,
     ErrorR,
     A extends HttpApiEndpoint.HttpApiEndpoint.All
-  >(
-    self: HttpApiGroup<Name, Endpoints, Error, ErrorR>,
-    endpoint: A
-  ): HttpApiGroup<Name, Endpoints | A, Error, ErrorR>
+  >(self: HttpApiGroup<Name, Endpoints, Error, ErrorR>, endpoint: A): HttpApiGroup<Name, Endpoints | A, Error, ErrorR>
 } = dual(2, <
   Name extends string,
   Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All,
@@ -215,6 +224,13 @@ export const add: {
  * @category errors
  */
 export const addError: {
+  /**
+   * Add an error schema to an `HttpApiGroup`, which is shared by all endpoints in the
+   * group.
+   *
+   * @since 1.0.0
+   * @category errors
+   */
   <A, I, R>(
     schema: Schema.Schema<A, I, R>,
     annotations?: {
@@ -223,6 +239,13 @@ export const addError: {
   ): <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR>(
     self: HttpApiGroup<Name, Endpoints, Error, ErrorR>
   ) => HttpApiGroup<Name, Endpoints, Error | A, ErrorR | R>
+  /**
+   * Add an error schema to an `HttpApiGroup`, which is shared by all endpoints in the
+   * group.
+   *
+   * @since 1.0.0
+   * @category errors
+   */
   <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR, A, I, R>(
     self: HttpApiGroup<Name, Endpoints, Error, ErrorR>,
     schema: Schema.Schema<A, I, R>,
@@ -260,11 +283,23 @@ export const addError: {
  * @category endpoints
  */
 export const prefix: {
-  (
-    prefix: PathInput
-  ): <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR>(
+  /**
+   * Add a path prefix to all endpoints in an `HttpApiGroup`. Note that this will only
+   * add the prefix to the endpoints before this api is called.
+   *
+   * @since 1.0.0
+   * @category endpoints
+   */
+  (prefix: PathInput): <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR>(
     self: HttpApiGroup<Name, Endpoints, Error, ErrorR>
   ) => HttpApiGroup<Name, Endpoints, Error, ErrorR>
+  /**
+   * Add a path prefix to all endpoints in an `HttpApiGroup`. Note that this will only
+   * add the prefix to the endpoints before this api is called.
+   *
+   * @since 1.0.0
+   * @category endpoints
+   */
   <Name extends string, Endpoints extends HttpApiEndpoint.HttpApiEndpoint.All, Error, ErrorR>(
     self: HttpApiGroup<Name, Endpoints, Error, ErrorR>,
     prefix: PathInput
@@ -287,7 +322,19 @@ export const prefix: {
  * @category annotations
  */
 export const annotateMerge: {
+  /**
+   * Merge the annotations of an `HttpApiGroup` with a new context.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <I>(context: Context.Context<I>): <A extends HttpApiGroup.Any>(self: A) => A
+  /**
+   * Merge the annotations of an `HttpApiGroup` with a new context.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiGroup.Any, I>(self: A, context: Context.Context<I>): A
 } = dual(
   2,
@@ -305,7 +352,19 @@ export const annotateMerge: {
  * @category annotations
  */
 export const annotate: {
+  /**
+   * Add an annotation to an `HttpApiGroup`.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <I, S>(tag: Context.Tag<I, S>, value: S): <A extends HttpApiGroup.Any>(self: A) => A
+  /**
+   * Add an annotation to an `HttpApiGroup`.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiGroup.Any, I, S>(self: A, tag: Context.Tag<I, S>, value: S): A
 } = dual(
   3,
@@ -328,7 +387,25 @@ export const annotate: {
  * @category annotations
  */
 export const annotateEndpointsMerge: {
+  /**
+   * For each endpoint in an `HttpApiGroup`, update the annotations with a new
+   * context.
+   *
+   * Note that this will only update the annotations before this api is called.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <I>(context: Context.Context<I>): <A extends HttpApiGroup.Any>(self: A) => A
+  /**
+   * For each endpoint in an `HttpApiGroup`, update the annotations with a new
+   * context.
+   *
+   * Note that this will only update the annotations before this api is called.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiGroup.Any, I>(self: A, context: Context.Context<I>): A
 } = dual(
   2,
@@ -351,7 +428,25 @@ export const annotateEndpointsMerge: {
  * @category annotations
  */
 export const annotateEndpoints: {
+  /**
+   * For each endpoint in an `HttpApiGroup`, add an annotation.
+   *
+   * Note that this will only add the annotation to the endpoints before this api
+   * is called.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <I, S>(tag: Context.Tag<I, S>, value: S): <A extends HttpApiGroup.Any>(self: A) => A
+  /**
+   * For each endpoint in an `HttpApiGroup`, add an annotation.
+   *
+   * Note that this will only add the annotation to the endpoints before this api
+   * is called.
+   *
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiGroup.Any, I, S>(self: A, tag: Context.Tag<I, S>, value: S): A
 } = dual(
   3,

package/src/HttpApiSchema.ts

@@ -181,10 +181,20 @@ export interface asEmpty<
  * @category empty response
  */
 export const asEmpty: {
-  <S extends Schema.Schema.Any>(options: {
-    readonly status: number
-    readonly decode: LazyArg<Schema.Schema.Type<S>>
-  }): (self: S) => asEmpty<S>
+  /**
+   * @since 1.0.0
+   * @category empty response
+   */
+  <S extends Schema.Schema.Any>(
+    options: {
+      readonly status: number
+      readonly decode: LazyArg<Schema.Schema.Type<S>>
+    }
+  ): (self: S) => asEmpty<S>
+  /**
+   * @since 1.0.0
+   * @category empty response
+   */
   <S extends Schema.Schema.Any>(
     self: S,
     options: {
@@ -335,12 +345,20 @@ export declare namespace Encoding {
  * @category encoding
  */
 export const withEncoding: {
+  /**
+   * @since 1.0.0
+   * @category encoding
+   */
   <A extends Schema.Schema.Any, Kind extends Encoding["kind"]>(
     options: {
       readonly kind: Kind
       readonly contentType?: string | undefined
     } & Encoding.Validate<A, Kind>
   ): (self: A) => A
+  /**
+   * @since 1.0.0
+   * @category encoding
+   */
   <A extends Schema.Schema.Any, Kind extends Encoding["kind"]>(
     self: A,
     options: {

package/src/HttpApiSecurity.ts

@@ -141,7 +141,15 @@ export const basic: Basic = Object.assign(Object.create(Proto), {
  * @category annotations
  */
 export const annotateMerge: {
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <I>(context: Context.Context<I>): <A extends HttpApiSecurity>(self: A) => A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiSecurity, I>(self: A, context: Context.Context<I>): A
 } = dual(
   2,
@@ -157,7 +165,15 @@ export const annotateMerge: {
  * @category annotations
  */
 export const annotate: {
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <I, S>(tag: Context.Tag<I, S>, value: S): <A extends HttpApiSecurity>(self: A) => A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApiSecurity, I, S>(self: A, tag: Context.Tag<I, S>, value: S): A
 } = dual(
   3,

package/src/HttpApp.ts

@@ -136,7 +136,15 @@ export const appendPreResponseHandler: (handler: PreResponseHandler) => Effect.E
  * @category fiber refs
  */
 export const withPreResponseHandler = dual<
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (handler: PreResponseHandler) => <A, E, R>(self: HttpApp<A, E, R>) => HttpApp<A, E, R>,
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(self: HttpApp<A, E, R>, handler: PreResponseHandler) => HttpApp<A, E, R>
 >(2, (self, handler) =>
   Effect.locallyWith(