@effect/platform 0.66.1 → 0.66.3

package/src/Cookies.ts

@@ -377,11 +377,20 @@ export const unsafeMakeCookie = (
  * @category combinators
  */
 export const setCookie: {
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (cookie: Cookie): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    cookie: Cookie
-  ): Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, cookie: Cookie): Cookies
 } = dual(
   2,
   (self: Cookies, cookie: Cookie) =>
@@ -399,11 +408,20 @@ export const setCookie: {
  * @category combinators
  */
 export const setAllCookie: {
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (cookies: Iterable<Cookie>): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    cookies: Iterable<Cookie>
-  ): Cookies
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, cookies: Iterable<Cookie>): Cookies
 } = dual(2, (self: Cookies, cookies: Iterable<Cookie>) => {
   const record = { ...self.cookies }
   for (const cookie of cookies) {
@@ -419,11 +437,20 @@ export const setAllCookie: {
  * @category combinators
  */
 export const merge: {
+  /**
+   * Combine two Cookies objects, removing duplicates from the first
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (that: Cookies): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    that: Cookies
-  ): Cookies
+  /**
+   * Combine two Cookies objects, removing duplicates from the first
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, that: Cookies): Cookies
 } = dual(2, (self: Cookies, that: Cookies) =>
   fromReadonlyRecord({
     ...self.cookies,
@@ -437,11 +464,20 @@ export const merge: {
  * @category combinators
  */
 export const remove: {
+  /**
+   * Remove a cookie by name
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    name: string
-  ): Cookies
+  /**
+   * Remove a cookie by name
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string): Cookies
 } = dual(2, (self: Cookies, name: string) => fromReadonlyRecord(Record.remove(self.cookies, name)))
 
 /**
@@ -451,7 +487,19 @@ export const remove: {
  * @category combinators
  */
 export const get: {
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Option.Option<Cookie>
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Cookies, name: string): Option.Option<Cookie>
 } = dual(
   (args) => isCookies(args[0]),
@@ -465,7 +513,19 @@ export const get: {
  * @category combinators
  */
 export const getValue: {
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Option.Option<string>
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Cookies, name: string): Option.Option<string>
 } = dual(
   (args) => isCookies(args[0]),
@@ -480,17 +540,20 @@ export const getValue: {
  * @category combinators
  */
 export const set: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (self: Cookies) => Either.Either<Cookies, CookiesError>
-  (
-    self: Cookies,
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): Either.Either<Cookies, CookiesError>
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Either.Either<Cookies, CookiesError>
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Either.Either<Cookies, CookiesError>
 } = dual(
   (args) => isCookies(args[0]),
   (self: Cookies, name: string, value: string, options?: Cookie["options"]) =>
@@ -507,17 +570,20 @@ export const set: {
  * @category combinators
  */
 export const unsafeSet: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Cookies
 } = dual(
   (args) => isCookies(args[0]),
   (self: Cookies, name: string, value: string, options?: Cookie["options"]) =>
@@ -535,9 +601,21 @@ export const unsafeSet: {
  * @category combinators
  */
 export const setAll: {
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
   ): (self: Cookies) => Either.Either<Cookies, CookiesError>
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: Cookies,
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
@@ -567,9 +645,21 @@ export const setAll: {
  * @category combinators
  */
 export const unsafeSetAll: {
+  /**
+   * Add multiple cookies to a Cookies object, throwing an error if invalid
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
   ): (self: Cookies) => Cookies
+  /**
+   * Add multiple cookies to a Cookies object, throwing an error if invalid
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: Cookies,
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>

package/src/Effectify.ts

@@ -244,11 +244,20 @@ export type EffectifyError<T> = T extends {
  * @since 1.0.0
  */
 export const effectify: {
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any>(fn: F): Effectify<F, EffectifyError<F>>
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any, E>(
     fn: F,
     onError: (error: EffectifyError<F>, args: Parameters<F>) => E
   ): Effectify<F, E>
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any, E, E2>(
     fn: F,
     onError: (error: EffectifyError<F>, args: Parameters<F>) => E,

package/src/Headers.ts

@@ -117,10 +117,26 @@ export const unsafeFromRecord = (input: Record.ReadonlyRecord<string, string>):
  * @category combinators
  */
 export const has: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => boolean
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): boolean
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => boolean,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => boolean
 >(2, (self, key) => key.toLowerCase() in self)
 
@@ -129,10 +145,26 @@ export const has: {
  * @category combinators
  */
 export const get: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => Option.Option<string>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): Option.Option<string>
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => Option.Option<string>,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => Option.Option<string>
 >(2, (self, key) => Record.get(self as Record<string, string>, key.toLowerCase()))
 
@@ -141,10 +173,26 @@ export const get: {
  * @category combinators
  */
 export const set: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string, value: string): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string, value: string) => Headers
 >(3, (self, key, value) => {
   const out = make(self)
@@ -157,10 +205,26 @@ export const set: {
  * @category combinators
  */
 export const setAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Input): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Input): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Input) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Input) => Headers
 >(2, (self, headers) =>
   make({
@@ -173,10 +237,26 @@ export const setAll: {
  * @category combinators
  */
 export const merge: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Headers): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Headers): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Headers) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Headers) => Headers
 >(2, (self, headers) => {
   const out = make(self)
@@ -189,10 +269,26 @@ export const merge: {
  * @category combinators
  */
 export const remove: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => Headers
 >(2, (self, key) => {
   const out = make(self)
@@ -205,13 +301,16 @@ export const remove: {
  * @category combinators
  */
 export const redact: {
-  (
-    key: string | RegExp | ReadonlyArray<string | RegExp>
-  ): (self: Headers) => Record<string, string | Redacted.Redacted>
-  (
-    self: Headers,
-    key: string | RegExp | ReadonlyArray<string | RegExp>
-  ): Record<string, string | Redacted.Redacted>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (key: string | RegExp | ReadonlyArray<string | RegExp>): (self: Headers) => Record<string, string | Redacted.Redacted>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Headers, key: string | RegExp | ReadonlyArray<string | RegExp>): Record<string, string | Redacted.Redacted>
 } = dual(
   2,
   (

package/src/HttpApi.ts

@@ -134,21 +134,45 @@ export const empty: HttpApi = makeProto({
  * @category constructors
  */
 export const addGroup: {
+  /**
+   * Add a `HttpApiGroup` to an `HttpApi`.
+   *
+   * @since 1.0.0
+   * @category constructors
+   */
   <Group extends HttpApiGroup.HttpApiGroup.Any>(
     group: Group
   ): <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR>(
     self: HttpApi<Groups, Error, ErrorR>
   ) => HttpApi<Groups | Group, Error, ErrorR>
+  /**
+   * Add a `HttpApiGroup` to an `HttpApi`.
+   *
+   * @since 1.0.0
+   * @category constructors
+   */
   <Group extends HttpApiGroup.HttpApiGroup.Any>(
     path: HttpRouter.PathInput,
     group: Group
   ): <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR>(
     self: HttpApi<Groups, Error, ErrorR>
   ) => HttpApi<Groups | Group, Error, ErrorR>
+  /**
+   * Add a `HttpApiGroup` to an `HttpApi`.
+   *
+   * @since 1.0.0
+   * @category constructors
+   */
   <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR, Group extends HttpApiGroup.HttpApiGroup.Any>(
     self: HttpApi<Groups, Error, ErrorR>,
     group: Group
   ): HttpApi<Groups | Group, Error, ErrorR>
+  /**
+   * Add a `HttpApiGroup` to an `HttpApi`.
+   *
+   * @since 1.0.0
+   * @category constructors
+   */
   <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR, Group extends HttpApiGroup.HttpApiGroup.Any>(
     self: HttpApi<Groups, Error, ErrorR>,
     path: HttpRouter.PathInput,
@@ -178,6 +202,15 @@ export const addGroup: {
  * @category errors
  */
 export const addError: {
+  /**
+   * Add an error schema to an `HttpApi`, which is shared by all endpoints in the
+   * `HttpApi`.
+   *
+   * Useful for adding error types from middleware or other shared error types.
+   *
+   * @since 1.0.0
+   * @category errors
+   */
   <A, I, R>(
     schema: Schema.Schema<A, I, R>,
     annotations?: {
@@ -186,6 +219,15 @@ export const addError: {
   ): <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR>(
     self: HttpApi<Groups, Error, ErrorR>
   ) => HttpApi<Groups, Error | A, ErrorR | R>
+  /**
+   * Add an error schema to an `HttpApi`, which is shared by all endpoints in the
+   * `HttpApi`.
+   *
+   * Useful for adding error types from middleware or other shared error types.
+   *
+   * @since 1.0.0
+   * @category errors
+   */
   <Groups extends HttpApiGroup.HttpApiGroup.Any, Error, ErrorR, A, I, R>(
     self: HttpApi<Groups, Error, ErrorR>,
     schema: Schema.Schema<A, I, R>,
@@ -219,7 +261,15 @@ export const addError: {
  * @category annotations
  */
 export const annotateMerge: {
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <I>(context: Context.Context<I>): <A extends HttpApi.Any>(self: A) => A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApi.Any, I>(self: A, context: Context.Context<I>): A
 } = dual(
   2,
@@ -236,7 +286,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 HttpApi.Any>(self: A) => A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
   <A extends HttpApi.Any, I, S>(self: A, tag: Context.Tag<I, S>, value: S): A
 } = dual(
   3,