effect 2.0.0-next.42 → 2.0.0-next.44

package/Context/dist/effect-Context.cjs.dev.js

@@ -2,36 +2,325 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-require('../../dist/Context-96739709.cjs.dev.js');
-var Context_dist_effectContext = require('../../dist/Context-3c9e986b.cjs.dev.js');
-require('../../dist/Equal-281b6ca8.cjs.dev.js');
-require('../../dist/Hash-bd154268.cjs.dev.js');
-require('../../dist/Function-41ce433d.cjs.dev.js');
-require('../../dist/GlobalValue-81ab6908.cjs.dev.js');
-require('../../dist/Utils-b0c14d1b.cjs.dev.js');
-require('../../dist/Predicate-9e859c9c.cjs.dev.js');
-require('../../dist/Inspectable-ac929af4.cjs.dev.js');
-require('../../dist/Option-03997d77.cjs.dev.js');
-require('../../dist/Equivalence-de7a0d51.cjs.dev.js');
-require('../../dist/Either-9c349424.cjs.dev.js');
-require('../../dist/Effectable-a6403e5f.cjs.dev.js');
-require('../../dist/Data-85559fb3.cjs.dev.js');
-require('../../dist/Pipeable-4698db72.cjs.dev.js');
-require('../../dist/Number-588f6483.cjs.dev.js');
-require('../../dist/Order-28bdebd2.cjs.dev.js');
-
-
-
-exports.Tag = Context_dist_effectContext.Tag;
-exports.add = Context_dist_effectContext.add;
-exports.empty = Context_dist_effectContext.empty;
-exports.get = Context_dist_effectContext.get;
-exports.getOption = Context_dist_effectContext.getOption;
-exports.isContext = Context_dist_effectContext.isContext;
-exports.isTag = Context_dist_effectContext.isTag;
-exports.make = Context_dist_effectContext.make;
-exports.merge = Context_dist_effectContext.merge;
-exports.omit = Context_dist_effectContext.omit;
-exports.pick = Context_dist_effectContext.pick;
-exports.unsafeGet = Context_dist_effectContext.unsafeGet;
-exports.unsafeMake = Context_dist_effectContext.unsafeMake;
+var Context = require('../../dist/Context-593661f6.cjs.dev.js');
+require('../../Equal/dist/effect-Equal.cjs.dev.js');
+require('../../Hash/dist/effect-Hash.cjs.dev.js');
+require('../../Function/dist/effect-Function.cjs.dev.js');
+require('../../GlobalValue/dist/effect-GlobalValue.cjs.dev.js');
+require('../../Utils/dist/effect-Utils.cjs.dev.js');
+require('../../Predicate/dist/effect-Predicate.cjs.dev.js');
+require('../../Inspectable/dist/effect-Inspectable.cjs.dev.js');
+require('../../Option/dist/effect-Option.cjs.dev.js');
+require('../../Equivalence/dist/effect-Equivalence.cjs.dev.js');
+require('../../dist/Either-12bbe00c.cjs.dev.js');
+require('../../dist/Effectable-2f022879.cjs.dev.js');
+require('../../Data/dist/effect-Data.cjs.dev.js');
+require('../../Pipeable/dist/effect-Pipeable.cjs.dev.js');
+require('../../Number/dist/effect-Number.cjs.dev.js');
+require('../../Order/dist/effect-Order.cjs.dev.js');
+
+/**
+ * This module provides a data structure called `Context` that can be used for dependency injection in effectful
+ * programs. It is essentially a table mapping `Tag`s to their implementations (called `Service`s), and can be used to
+ * manage dependencies in a type-safe way. The `Context` data structure is essentially a way of providing access to a set
+ * of related services that can be passed around as a single unit. This module provides functions to create, modify, and
+ * query the contents of a `Context`, as well as a number of utility types for working with tags and services.
+ *
+ * @since 2.0.0
+ */
+
+/**
+ * @since 2.0.0
+ * @category symbol
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @category models
+ * @since 2.0.0
+ */
+
+/**
+ * @category models
+ * @since 2.0.0
+ */
+
+/**
+ * @since 2.0.0
+ */
+
+/**
+ * Creates a new `Tag` instance with an optional key parameter.
+ *
+ * Specifying the `key` will make the `Tag` global, meaning two tags with the same
+ * key will map to the same instance.
+ *
+ * Note: this is useful for cases where live reload can happen and it is
+ * desireable to preserve the instance across reloads.
+ *
+ * @param key - An optional key that makes the `Tag` global.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * assert.strictEqual(Context.Tag() === Context.Tag(), false)
+ * assert.strictEqual(Context.Tag("PORT") === Context.Tag("PORT"), true)
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const Tag = Context.makeTag;
+
+/**
+ * @since 2.0.0
+ * @category symbol
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ * @category constructors
+ */
+const unsafeMake = Context.makeContext;
+
+/**
+ * Checks if the provided argument is a `Context`.
+ *
+ * @param input - The value to be checked if it is a `Context`.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * assert.strictEqual(Context.isContext(Context.empty()), true)
+ *
+ * @since 2.0.0
+ * @category guards
+ */
+const isContext = Context.isContext;
+
+/**
+ * Checks if the provided argument is a `Tag`.
+ *
+ * @param input - The value to be checked if it is a `Tag`.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * assert.strictEqual(Context.isTag(Context.Tag()), true)
+ *
+ * @since 2.0.0
+ * @category guards
+ */
+const isTag = Context.isTag;
+
+/**
+ * Returns an empty `Context`.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * assert.strictEqual(Context.isContext(Context.empty()), true)
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const empty = Context.empty;
+
+/**
+ * Creates a new `Context` with a single service associated to the tag.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ *
+ * const Services = Context.make(Port, { PORT: 8080 })
+ *
+ * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const make = Context.make;
+
+/**
+ * Adds a service to a given `Context`.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ * import { pipe } from "effect/Function"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const someContext = Context.make(Port, { PORT: 8080 })
+ *
+ * const Services = pipe(
+ *   someContext,
+ *   Context.add(Timeout, { TIMEOUT: 5000 })
+ * )
+ *
+ * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
+ * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ *
+ * @since 2.0.0
+ */
+const add = Context.add;
+
+/**
+ * Get a service from the context that corresponds to the given tag.
+ *
+ * @param self - The `Context` to search for the service.
+ * @param tag - The `Tag` of the service to retrieve.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ * import { pipe } from "effect/Function"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const Services = pipe(
+ *   Context.make(Port, { PORT: 8080 }),
+ *   Context.add(Timeout, { TIMEOUT: 5000 })
+ * )
+ *
+ * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const get = Context.get;
+
+/**
+ * Get a service from the context that corresponds to the given tag.
+ * This function is unsafe because if the tag is not present in the context, a runtime error will be thrown.
+ *
+ * For a safer version see {@link getOption}.
+ *
+ * @param self - The `Context` to search for the service.
+ * @param tag - The `Tag` of the service to retrieve.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const Services = Context.make(Port, { PORT: 8080 })
+ *
+ * assert.deepStrictEqual(Context.unsafeGet(Services, Port), { PORT: 8080 })
+ * assert.throws(() => Context.unsafeGet(Services, Timeout))
+ *
+ * @since 2.0.0
+ * @category unsafe
+ */
+const unsafeGet = Context.unsafeGet;
+
+/**
+ * Get the value associated with the specified tag from the context wrapped in an `Option` object. If the tag is not
+ * found, the `Option` object will be `None`.
+ *
+ * @param self - The `Context` to search for the service.
+ * @param tag - The `Tag` of the service to retrieve.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ * import * as O from "effect/Option"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const Services = Context.make(Port, { PORT: 8080 })
+ *
+ * assert.deepStrictEqual(Context.getOption(Services, Port), O.some({ PORT: 8080 }))
+ * assert.deepStrictEqual(Context.getOption(Services, Timeout), O.none())
+ *
+ * @since 2.0.0
+ * @category getters
+ */
+const getOption = Context.getOption;
+
+/**
+ * Merges two `Context`s, returning a new `Context` containing the services of both.
+ *
+ * @param self - The first `Context` to merge.
+ * @param that - The second `Context` to merge.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const firstContext = Context.make(Port, { PORT: 8080 })
+ * const secondContext = Context.make(Timeout, { TIMEOUT: 5000 })
+ *
+ * const Services = Context.merge(firstContext, secondContext)
+ *
+ * assert.deepStrictEqual(Context.get(Services, Port), { PORT: 8080 })
+ * assert.deepStrictEqual(Context.get(Services, Timeout), { TIMEOUT: 5000 })
+ *
+ * @since 2.0.0
+ */
+const merge = Context.merge;
+
+/**
+ * Returns a new `Context` that contains only the specified services.
+ *
+ * @param self - The `Context` to prune services from.
+ * @param tags - The list of `Tag`s to be included in the new `Context`.
+ *
+ * @example
+ * import * as Context from "effect/Context"
+ * import { pipe } from "effect/Function"
+ * import * as O from "effect/Option"
+ *
+ * const Port = Context.Tag<{ PORT: number }>()
+ * const Timeout = Context.Tag<{ TIMEOUT: number }>()
+ *
+ * const someContext = pipe(
+ *   Context.make(Port, { PORT: 8080 }),
+ *   Context.add(Timeout, { TIMEOUT: 5000 })
+ * )
+ *
+ * const Services = pipe(someContext, Context.pick(Port))
+ *
+ * assert.deepStrictEqual(Context.getOption(Services, Port), O.some({ PORT: 8080 }))
+ * assert.deepStrictEqual(Context.getOption(Services, Timeout), O.none())
+ *
+ * @since 2.0.0
+ */
+const pick = Context.pick;
+
+/**
+ * @since 2.0.0
+ */
+const omit = Context.omit;
+
+exports.Tag = Tag;
+exports.add = add;
+exports.empty = empty;
+exports.get = get;
+exports.getOption = getOption;
+exports.isContext = isContext;
+exports.isTag = isTag;
+exports.make = make;
+exports.merge = merge;
+exports.omit = omit;
+exports.pick = pick;
+exports.unsafeGet = unsafeGet;
+exports.unsafeMake = unsafeMake;