effect 3.8.4 → 3.9.0

package/src/Config.ts

@@ -226,7 +226,21 @@ export const isConfig: (u: unknown) => u is Config<unknown> = internal.isConfig
  * @category mapping
  */
 export const map: {
+  /**
+   * Returns a  config whose structure is the same as this one, but which produces
+   * a different value, constructed using the specified function.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, B>(f: (a: A) => B): (self: Config<A>) => Config<B>
+  /**
+   * Returns a  config whose structure is the same as this one, but which produces
+   * a different value, constructed using the specified function.
+   *
+   * @since 2.0.0
+   * @category mapping
+   */
   <A, B>(self: Config<A>, f: (a: A) => B): Config<B>
 } = internal.map
 
@@ -239,7 +253,23 @@ export const map: {
  * @category utils
  */
 export const mapAttempt: {
+  /**
+   * Returns a config whose structure is the same as this one, but which may
+   * produce a different value, constructed using the specified function, which
+   * may throw exceptions that will be translated into validation errors.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(f: (a: A) => B): (self: Config<A>) => Config<B>
+  /**
+   * Returns a config whose structure is the same as this one, but which may
+   * produce a different value, constructed using the specified function, which
+   * may throw exceptions that will be translated into validation errors.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(self: Config<A>, f: (a: A) => B): Config<B>
 } = internal.mapAttempt
 
@@ -252,7 +282,23 @@ export const mapAttempt: {
  * @category utils
  */
 export const mapOrFail: {
+  /**
+   * Returns a new config whose structure is the samea as this one, but which
+   * may produce a different value, constructed using the specified fallible
+   * function.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(f: (a: A) => Either.Either<B, ConfigError.ConfigError>): (self: Config<A>) => Config<B>
+  /**
+   * Returns a new config whose structure is the samea as this one, but which
+   * may produce a different value, constructed using the specified fallible
+   * function.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B>(self: Config<A>, f: (a: A) => Either.Either<B, ConfigError.ConfigError>): Config<B>
 } = internal.mapOrFail
 
@@ -264,7 +310,21 @@ export const mapOrFail: {
  * @category utils
  */
 export const nested: {
+  /**
+   * Returns a config that has this configuration nested as a property of the
+   * specified name.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (name: string): <A>(self: Config<A>) => Config<A>
+  /**
+   * Returns a config that has this configuration nested as a property of the
+   * specified name.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: Config<A>, name: string): Config<A>
 } = internal.nested
 
@@ -277,7 +337,23 @@ export const nested: {
  * @category utils
  */
 export const orElse: {
+  /**
+   * Returns a config whose structure is preferentially described by this
+   * config, but which falls back to the specified config if there is an issue
+   * reading from this config.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A2>(that: LazyArg<Config<A2>>): <A>(self: Config<A>) => Config<A2 | A>
+  /**
+   * Returns a config whose structure is preferentially described by this
+   * config, but which falls back to the specified config if there is an issue
+   * reading from this config.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, A2>(self: Config<A>, that: LazyArg<Config<A2>>): Config<A | A2>
 } = internal.orElse
 
@@ -290,12 +366,28 @@ export const orElse: {
  * @category utils
  */
 export const orElseIf: {
+  /**
+   * Returns configuration which reads from this configuration, but which falls
+   * back to the specified configuration if reading from this configuration
+   * fails with an error satisfying the specified predicate.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A2>(
     options: {
       readonly if: Predicate<ConfigError.ConfigError>
       readonly orElse: LazyArg<Config<A2>>
     }
   ): <A>(self: Config<A>) => Config<A>
+  /**
+   * Returns configuration which reads from this configuration, but which falls
+   * back to the specified configuration if reading from this configuration
+   * fails with an error satisfying the specified predicate.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, A2>(
     self: Config<A>,
     options: {
@@ -433,16 +525,39 @@ export const unwrap: <A>(wrapped: Config.Wrap<A>) => Config<A> = internal.unwrap
  * @category utils
  */
 export const validate: {
+  /**
+   * Returns a config that describes the same structure as this one, but which
+   * performs validation during loading.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B extends A>(
     options: {
       readonly message: string
       readonly validation: Refinement<A, B>
     }
   ): (self: Config<A>) => Config<B>
-  <A>(options: {
-    readonly message: string
-    readonly validation: Predicate<A>
-  }): (self: Config<A>) => Config<A>
+  /**
+   * Returns a config that describes the same structure as this one, but which
+   * performs validation during loading.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  <A>(
+    options: {
+      readonly message: string
+      readonly validation: Predicate<A>
+    }
+  ): (self: Config<A>) => Config<A>
+  /**
+   * Returns a config that describes the same structure as this one, but which
+   * performs validation during loading.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, B extends A>(
     self: Config<A>,
     options: {
@@ -450,10 +565,20 @@ export const validate: {
       readonly validation: Refinement<A, B>
     }
   ): Config<B>
-  <A>(self: Config<A>, options: {
-    readonly message: string
-    readonly validation: Predicate<A>
-  }): Config<A>
+  /**
+   * Returns a config that describes the same structure as this one, but which
+   * performs validation during loading.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
+  <A>(
+    self: Config<A>,
+    options: {
+      readonly message: string
+      readonly validation: Predicate<A>
+    }
+  ): Config<A>
 } = internal.validate
 
 /**
@@ -464,7 +589,21 @@ export const validate: {
  * @category utils
  */
 export const withDefault: {
+  /**
+   * Returns a config that describes the same structure as this one, but has the
+   * specified default value in case the information cannot be found.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <const A2>(def: A2): <A>(self: Config<A>) => Config<A2 | A>
+  /**
+   * Returns a config that describes the same structure as this one, but has the
+   * specified default value in case the information cannot be found.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A, const A2>(self: Config<A>, def: A2): Config<A | A2>
 } = internal.withDefault
 
@@ -475,7 +614,19 @@ export const withDefault: {
  * @category utils
  */
 export const withDescription: {
+  /**
+   * Adds a description to this configuration, which is intended for humans.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (description: string): <A>(self: Config<A>) => Config<A>
+  /**
+   * Adds a description to this configuration, which is intended for humans.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   <A>(self: Config<A>, description: string): Config<A>
 } = internal.withDescription
 
@@ -487,7 +638,21 @@ export const withDescription: {
  * @category zipping
  */
 export const zip: {
+  /**
+   * Returns a config that is the composition of this config and the specified
+   * config.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <B>(that: Config<B>): <A>(self: Config<A>) => Config<[A, B]>
+  /**
+   * Returns a config that is the composition of this config and the specified
+   * config.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, B>(self: Config<A>, that: Config<B>): Config<[A, B]>
 } = internal.zip
 
@@ -499,6 +664,20 @@ export const zip: {
  * @category zipping
  */
 export const zipWith: {
+  /**
+   * Returns a config that is the composes this config and the specified config
+   * using the provided function.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <B, A, C>(that: Config<B>, f: (a: A, b: B) => C): (self: Config<A>) => Config<C>
+  /**
+   * Returns a config that is the composes this config and the specified config
+   * using the provided function.
+   *
+   * @since 2.0.0
+   * @category zipping
+   */
   <A, B, C>(self: Config<A>, that: Config<B>, f: (a: A, b: B) => C): Config<C>
 } = internal.zipWith

package/src/ConfigError.ts

@@ -254,7 +254,15 @@ export const isUnsupported: (self: ConfigError) => self is Unsupported = interna
  * @category utils
  */
 export const prefixed: {
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   (prefix: Array<string>): (self: ConfigError) => ConfigError
+  /**
+   * @since 2.0.0
+   * @category utils
+   */
   (self: ConfigError, prefix: Array<string>): ConfigError
 } = internal.prefixed
 
@@ -263,6 +271,14 @@ export const prefixed: {
  * @category folding
  */
 export const reduceWithContext: {
+  /**
+   * @since 2.0.0
+   * @category folding
+   */
   <C, Z>(context: C, reducer: ConfigErrorReducer<C, Z>): (self: ConfigError) => Z
+  /**
+   * @since 2.0.0
+   * @category folding
+   */
   <C, Z>(self: ConfigError, context: C, reducer: ConfigErrorReducer<C, Z>): Z
 } = internal.reduceWithContext

package/src/ConfigProvider.ts

@@ -226,7 +226,25 @@ export const constantCase: (self: ConfigProvider) => ConfigProvider = internal.c
  * @category utils
  */
 export const mapInputPath: {
+  /**
+   * Returns a new config provider that will automatically tranform all path
+   * configuration names with the specified function. This can be utilized to
+   * adapt the names of configuration properties from one naming convention to
+   * another.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (f: (path: string) => string): (self: ConfigProvider) => ConfigProvider
+  /**
+   * Returns a new config provider that will automatically tranform all path
+   * configuration names with the specified function. This can be utilized to
+   * adapt the names of configuration properties from one naming convention to
+   * another.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: ConfigProvider, f: (path: string) => string): ConfigProvider
 } = internal.mapInputPath
 
@@ -262,7 +280,25 @@ export const lowerCase: (self: ConfigProvider) => ConfigProvider = internal.lowe
  * @category utils
  */
 export const nested: {
+  /**
+   * Returns a new config provider that will automatically nest all
+   * configuration under the specified property name. This can be utilized to
+   * aggregate separate configuration sources that are all required to load a
+   * single configuration value.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (name: string): (self: ConfigProvider) => ConfigProvider
+  /**
+   * Returns a new config provider that will automatically nest all
+   * configuration under the specified property name. This can be utilized to
+   * aggregate separate configuration sources that are all required to load a
+   * single configuration value.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: ConfigProvider, name: string): ConfigProvider
 } = internal.nested
 
@@ -275,7 +311,23 @@ export const nested: {
  * @category utils
  */
 export const orElse: {
+  /**
+   * Returns a new config provider that preferentially loads configuration data
+   * from this one, but which will fall back to the specified alternate provider
+   * if there are any issues loading the configuration from this provider.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (that: LazyArg<ConfigProvider>): (self: ConfigProvider) => ConfigProvider
+  /**
+   * Returns a new config provider that preferentially loads configuration data
+   * from this one, but which will fall back to the specified alternate provider
+   * if there are any issues loading the configuration from this provider.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: ConfigProvider, that: LazyArg<ConfigProvider>): ConfigProvider
 } = internal.orElse
 
@@ -289,7 +341,25 @@ export const orElse: {
  * @category utils
  */
 export const unnested: {
+  /**
+   * Returns a new config provider that will automatically un-nest all
+   * configuration under the specified property name. This can be utilized to
+   * de-aggregate separate configuration sources that are all required to load a
+   * single configuration value.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (name: string): (self: ConfigProvider) => ConfigProvider
+  /**
+   * Returns a new config provider that will automatically un-nest all
+   * configuration under the specified property name. This can be utilized to
+   * de-aggregate separate configuration sources that are all required to load a
+   * single configuration value.
+   *
+   * @since 2.0.0
+   * @category utils
+   */
   (self: ConfigProvider, name: string): ConfigProvider
 } = internal.unnested
 
@@ -323,6 +393,24 @@ export const upperCase: (self: ConfigProvider) => ConfigProvider = internal.uppe
  * @category combinators
  */
 export const within: {
+  /**
+   * Returns a new config provider that transforms the config provider with the
+   * specified function within the specified path.
+   *
+   * @since 2.0.0
+   * @category combinators
+   */
   (path: ReadonlyArray<string>, f: (self: ConfigProvider) => ConfigProvider): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, path: ReadonlyArray<string>, f: (self: ConfigProvider) => ConfigProvider): ConfigProvider
+  /**
+   * Returns a new config provider that transforms the config provider with the
+   * specified function within the specified path.
+   *
+   * @since 2.0.0
+   * @category combinators
+   */
+  (
+    self: ConfigProvider,
+    path: ReadonlyArray<string>,
+    f: (self: ConfigProvider) => ConfigProvider
+  ): ConfigProvider
 } = internal.within

package/src/ConfigProviderPathPatch.ts

@@ -68,7 +68,15 @@ export const empty: PathPatch = internal.empty
  * @category constructors
  */
 export const andThen: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (that: PathPatch): (self: PathPatch) => PathPatch
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: PathPatch, that: PathPatch): PathPatch
 } = internal.andThen
 
@@ -77,7 +85,15 @@ export const andThen: {
  * @category constructors
  */
 export const mapName: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (f: (string: string) => string): (self: PathPatch) => PathPatch
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: PathPatch, f: (string: string) => string): PathPatch
 } = internal.mapName
 
@@ -86,7 +102,15 @@ export const mapName: {
  * @category constructors
  */
 export const nested: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (name: string): (self: PathPatch) => PathPatch
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: PathPatch, name: string): PathPatch
 } = internal.nested
 
@@ -95,6 +119,14 @@ export const nested: {
  * @category constructors
  */
 export const unnested: {
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (name: string): (self: PathPatch) => PathPatch
+  /**
+   * @since 2.0.0
+   * @category constructors
+   */
   (self: PathPatch, name: string): PathPatch
 } = internal.unnested

package/src/Console.ts

@@ -87,7 +87,15 @@ export const Console: Context.Tag<Console, Console> = defaultConsole.consoleTag
  * @category default services
  */
 export const withConsole: {
+  /**
+   * @since 2.0.0
+   * @category default services
+   */
   <C extends Console>(console: C): <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category default services
+   */
   <A, E, R, C extends Console>(effect: Effect<A, E, R>, console: C): Effect<A, E, R>
 } = internal.withConsole
 
@@ -206,14 +214,27 @@ export const warn: (...args: ReadonlyArray<any>) => Effect<void> = internal.warn
  * @category accessor
  */
 export const withGroup: {
-  (options?: {
-    readonly label?: string | undefined
-    readonly collapsed?: boolean | undefined
-  }): <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, R>
-  <A, E, R>(self: Effect<A, E, R>, options?: {
-    readonly label?: string | undefined
-    readonly collapsed?: boolean | undefined
-  }): Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category accessor
+   */
+  (
+    options?: {
+      readonly label?: string | undefined
+      readonly collapsed?: boolean | undefined
+    }
+  ): <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category accessor
+   */
+  <A, E, R>(
+    self: Effect<A, E, R>,
+    options?: {
+      readonly label?: string | undefined
+      readonly collapsed?: boolean | undefined
+    }
+  ): Effect<A, E, R>
 } = internal.withGroup
 
 /**
@@ -221,6 +242,14 @@ export const withGroup: {
  * @category accessor
  */
 export const withTime: {
+  /**
+   * @since 2.0.0
+   * @category accessor
+   */
   (label?: string): <A, E, R>(self: Effect<A, E, R>) => Effect<A, E, R>
+  /**
+   * @since 2.0.0
+   * @category accessor
+   */
   <A, E, R>(self: Effect<A, E, R>, label?: string): Effect<A, E, R>
 } = internal.withTime