Lorem Ipsum MCP Server

/** * @since 2.0.0 */ import type * as Brand from "./Brand.js"; import type * as Chunk from "./Chunk.js"; import type * as ConfigError from "./ConfigError.js"; import type * as Duration from "./Duration.js"; import type * as Effect from "./Effect.js"; import type * as Either from "./Either.js"; import type { LazyArg } from "./Function.js"; import type * as HashMap from "./HashMap.js"; import type * as HashSet from "./HashSet.js"; import type * as LogLevel from "./LogLevel.js"; import type * as Option from "./Option.js"; import type { Predicate, Refinement } from "./Predicate.js"; import type * as Redacted from "./Redacted.js"; import type * as Secret from "./Secret.js"; import type * as Types from "./Types.js"; /** * @since 2.0.0 * @category symbols */ export declare const ConfigTypeId: unique symbol; /** * @since 2.0.0 * @category symbols */ export type ConfigTypeId = typeof ConfigTypeId; /** * A `Config` describes the structure of some configuration data. * * @since 2.0.0 * @category models */ export interface Config<out A> extends Config.Variance<A>, Effect.Effect<A, ConfigError.ConfigError> { } /** * @since 2.0.0 */ export declare namespace Config { /** * @since 2.0.0 * @category models */ interface Variance<out A> { readonly [ConfigTypeId]: { readonly _A: Types.Covariant<A>; }; } /** * @since 2.5.0 * @category models */ type Success<T extends Config<any>> = [T] extends [Config<infer _A>] ? _A : never; /** * @since 2.0.0 * @category models */ interface Primitive<out A> extends Config<A> { readonly description: string; parse(text: string): Either.Either<A, ConfigError.ConfigError>; } /** * Wraps a nested structure, converting all primitives to a `Config`. * * `Config.Wrap<{ key: string }>` becomes `{ key: Config<string> }` * * To create the resulting config, use the `unwrap` constructor. * * @since 2.0.0 * @category models */ type Wrap<A> = [NonNullable<A>] extends [infer T] ? [IsPlainObject<T>] extends [true] ? { readonly [K in keyof A]: Wrap<A[K]>; } | Config<A> : Config<A> : Config<A>; type IsPlainObject<A> = [A] extends [Record<string, any>] ? [keyof A] extends [never] ? false : [keyof A] extends [string] ? true : false : false; } /** * @since 2.0.0 * @category models */ export type LiteralValue = string | number | boolean | null | bigint; /** * Constructs a config from a tuple / struct / arguments of configs. * * @since 2.0.0 * @category constructors */ export declare const all: <const Arg extends Iterable<Config<any>> | Record<string, Config<any>>>(arg: Arg) => Config<[ Arg ] extends [ReadonlyArray<Config<any>>] ? { -readonly [K in keyof Arg]: [Arg[K]] extends [Config<infer A>] ? A : never; } : [Arg] extends [Iterable<Config<infer A>>] ? Array<A> : [Arg] extends [Record<string, Config<any>>] ? { -readonly [K in keyof Arg]: [Arg[K]] extends [Config<infer A>] ? A : never; } : never>; /** * Constructs a config for an array of values. * * @since 2.0.0 * @category constructors */ export declare const array: <A>(config: Config<A>, name?: string) => Config<Array<A>>; /** * Constructs a config for a boolean value. * * @since 2.0.0 * @category constructors */ export declare const boolean: (name?: string) => Config<boolean>; /** * Constructs a config for a network port [1, 65535]. * * @since 3.16.0 * @category constructors */ export declare const port: (name?: string) => Config<number>; /** * Constructs a config for an URL value. * * @since 3.11.0 * @category constructors */ export declare const url: (name?: string) => Config<URL>; /** * Constructs a config for a sequence of values. * * @since 2.0.0 * @category constructors */ export declare const chunk: <A>(config: Config<A>, name?: string) => Config<Chunk.Chunk<A>>; /** * Constructs a config for a date value. * * @since 2.0.0 * @category constructors */ export declare const date: (name?: string) => Config<Date>; /** * Constructs a config that fails with the specified message. * * @since 2.0.0 * @category constructors */ export declare const fail: (message: string) => Config<never>; /** * Constructs a config for a float value. * * @since 2.0.0 * @category constructors */ export declare const number: (name?: string) => Config<number>; /** * Constructs a config for a integer value. * * @since 2.0.0 * @category constructors */ export declare const integer: (name?: string) => Config<number>; /** * Constructs a config for a literal value. * * **Example** * * ```ts * import { Config } from "effect" * * const config = Config.literal("http", "https")("PROTOCOL") * ``` * * @since 2.0.0 * @category constructors */ export declare const literal: <Literals extends ReadonlyArray<LiteralValue>>(...literals: Literals) => (name?: string) => Config<Literals[number]>; /** * Constructs a config for a `LogLevel` value. * * @since 2.0.0 * @category constructors */ export declare const logLevel: (name?: string) => Config<LogLevel.LogLevel>; /** * Constructs a config for a duration value. * * @since 2.5.0 * @category constructors */ export declare const duration: (name?: string) => Config<Duration.Duration>; /** * This function returns `true` if the specified value is an `Config` value, * `false` otherwise. * * This function can be useful for checking the type of a value before * attempting to operate on it as an `Config` value. For example, you could * use `isConfig` to check the type of a value before using it as an * argument to a function that expects an `Config` value. * * @since 2.0.0 * @category refinements */ export declare const isConfig: (u: unknown) => u is Config<unknown>; /** * 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 */ export declare 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>; }; /** * 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 */ export declare 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>; }; /** * 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 */ export declare 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>; }; /** * Returns a config that has this configuration nested as a property of the * specified name. * * @since 2.0.0 * @category utils */ export declare 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>; }; /** * 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 */ export declare 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>; }; /** * 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 */ export declare 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: { readonly if: Predicate<ConfigError.ConfigError>; readonly orElse: LazyArg<Config<A2>>; }): Config<A>; }; /** * Returns an optional version of this config, which will be `None` if the * data is missing from configuration, and `Some` otherwise. * * @since 2.0.0 * @category utils */ export declare const option: <A>(self: Config<A>) => Config<Option.Option<A>>; /** * Constructs a new primitive config. * * @since 2.0.0 * @category constructors */ export declare const primitive: <A>(description: string, parse: (text: string) => Either.Either<A, ConfigError.ConfigError>) => Config<A>; /** * Returns a config that describes a sequence of values, each of which has the * structure of this config. * * @since 2.0.0 * @category utils */ export declare const repeat: <A>(self: Config<A>) => Config<Array<A>>; /** * Constructs a config for a secret value. * * @since 2.0.0 * @category constructors * @deprecated */ export declare const secret: (name?: string) => Config<Secret.Secret>; /** * Constructs a config for a redacted value. * * @since 2.0.0 * @category constructors */ export declare const redacted: { /** * Constructs a config for a redacted value. * * @since 2.0.0 * @category constructors */ (name?: string): Config<Redacted.Redacted>; /** * Constructs a config for a redacted value. * * @since 2.0.0 * @category constructors */ <A>(config: Config<A>): Config<Redacted.Redacted<A>>; }; /** * Constructs a config for a branded value. * * @since 3.16.0 * @category constructors */ export declare const branded: { /** * Constructs a config for a branded value. * * @since 3.16.0 * @category constructors */ <A, B extends Brand.Branded<A, any>>(constructor: Brand.Brand.Constructor<B>): (config: Config<A>) => Config<B>; /** * Constructs a config for a branded value. * * @since 3.16.0 * @category constructors */ <B extends Brand.Branded<string, any>>(name: string | undefined, constructor: Brand.Brand.Constructor<B>): Config<B>; /** * Constructs a config for a branded value. * * @since 3.16.0 * @category constructors */ <A, B extends Brand.Branded<A, any>>(config: Config<A>, constructor: Brand.Brand.Constructor<B>): Config<B>; }; /** * Constructs a config for a sequence of values. * * @since 2.0.0 * @category constructors */ export declare const hashSet: <A>(config: Config<A>, name?: string) => Config<HashSet.HashSet<A>>; /** * Constructs a config for a string value. * * @since 2.0.0 * @category constructors */ export declare const string: (name?: string) => Config<string>; /** * Constructs a config for a non-empty string value. * * @since 3.7.0 * @category constructors */ export declare const nonEmptyString: (name?: string) => Config<string>; /** * Constructs a config which contains the specified value. * * @since 2.0.0 * @category constructors */ export declare const succeed: <A>(value: A) => Config<A>; /** * Lazily constructs a config. * * @since 2.0.0 * @category constructors */ export declare const suspend: <A>(config: LazyArg<Config<A>>) => Config<A>; /** * Constructs a config which contains the specified lazy value. * * @since 2.0.0 * @category constructors */ export declare const sync: <A>(value: LazyArg<A>) => Config<A>; /** * Constructs a config for a sequence of values. * * @since 2.0.0 * @category constructors */ export declare const hashMap: <A>(config: Config<A>, name?: string) => Config<HashMap.HashMap<string, A>>; /** * Constructs a config from some configuration wrapped with the `Wrap<A>` utility type. * * For example: * * ``` * import { Config, unwrap } from "./Config" * * interface Options { key: string } * * const makeConfig = (config: Config.Wrap<Options>): Config<Options> => unwrap(config) * ``` * * @since 2.0.0 * @category constructors */ export declare const unwrap: <A>(wrapped: Config.Wrap<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 */ export declare 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>; /** * 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: { readonly message: string; readonly validation: Refinement<A, B>; }): Config<B>; /** * 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>; }; /** * 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 */ export declare 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>; }; /** * Adds a description to this configuration, which is intended for humans. * * @since 2.0.0 * @category utils */ export declare 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>; }; /** * Returns a config that is the composition of this config and the specified * config. * * @since 2.0.0 * @category zipping */ export declare 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]>; }; /** * Returns a config that is the composes this config and the specified config * using the provided function. * * @since 2.0.0 * @category zipping */ export declare 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>; }; //# sourceMappingURL=Config.d.ts.map