effect 4.0.1 → 4.0.2

package/src/JsonPatch.ts

@@ -5,6 +5,7 @@
  * difference between two JSON documents, serialize that difference, and replay
  * it without mutating the original input.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as InternalRecord from "./internal/record.ts"
@@ -56,6 +57,7 @@ import type * as Schema from "./Schema.ts"
  * @see {@link JsonPatch} for the array of operations forming a complete patch
  * @see {@link get} to compute operations automatically from value differences
  * @see {@link apply} to apply operations to transform documents
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -131,6 +133,7 @@ export type JsonPatchOperation =
  * @see {@link JsonPatchOperation} for individual operation types
  * @see {@link get} to generate patches from value differences
  * @see {@link apply} to execute patches to transform documents
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -174,6 +177,7 @@ export type JsonPatch = ReadonlyArray<JsonPatchOperation>
  *
  * @see {@link apply} to apply the generated patch to a document
  * @see {@link JsonPatchOperation} for the operation types in the patch
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -276,6 +280,7 @@ function getLoop(
  *
  * @see {@link get} to generate patches from value differences
  * @see {@link JsonPatchOperation} for the operation types being applied
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */

package/src/JsonPointer.ts

@@ -4,6 +4,7 @@
  * document, so token text must encode literal `~` and `/` characters. URI
  * fragments additionally apply percent-encoding after JSON Pointer escaping.
  *
+ * @stability stable
  * @since 4.0.0
  */
 
@@ -36,6 +37,7 @@
  * ```
  *
  * @see {@link unescapeToken} The inverse operation for decoding escaped tokens
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -72,6 +74,7 @@ export function escapeToken(token: string): string {
  * ```
  *
  * @see {@link escapeToken} The inverse operation for encoding tokens
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -129,6 +132,7 @@ export function decodeUriFragment(fragment: string): string | undefined {
  * ```
  *
  * @see {@link formatUriFragment} for the inverse operation
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -162,6 +166,7 @@ export function parseUriFragment(fragment: string): ReadonlyArray<string> | unde
  * ```
  *
  * @see {@link parseUriFragment} for the inverse operation
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */

package/src/JsonSchema.ts

@@ -6,6 +6,7 @@
  * JSON Schema Draft-04. The module also defines document types, meta-schema
  * constants, and OpenAPI component-key helpers.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as InternalRecord from "./internal/record.ts"
@@ -24,6 +25,7 @@ import * as Predicate from "./Predicate.ts"
  * This is an open record type (`[x: string]: unknown`) so it can hold any JSON
  * Schema keyword. Most functions in this module accept or return this type.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -49,6 +51,7 @@ export interface JsonSchema {
  * @see {@link Document} for a single root schema tagged with a dialect
  * @see {@link MultiDocument} for multiple root schemas tagged with a dialect
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -61,6 +64,7 @@ export type Dialect = "draft-04" | "draft-07" | "draft-2020-12" | "openapi-3.1"
  *
  * Use to restrict a JSON Schema `type` keyword to the supported primitive names.
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -81,6 +85,7 @@ export type Type = "string" | "number" | "boolean" | "array" | "object" | "null"
  *
  * @see {@link Document} for a single root schema with definitions
  * @see {@link MultiDocument} for multiple root schemas sharing definitions
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -123,6 +128,7 @@ export interface Definitions extends Record<string, JsonSchema> {}
  *
  * @see {@link MultiDocument}
  * @see {@link fromSchemaDraft2020_12}
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -147,6 +153,7 @@ export interface Document<D extends Dialect> {
  *
  * @see {@link Document}
  * @see {@link toMultiDocumentOpenApi3_1}
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -165,6 +172,7 @@ export interface MultiDocument<D extends Dialect> {
  * value for the root `$schema` field.
  *
  * @see {@link META_SCHEMA_URI_DRAFT_07} for the Draft-07 `$schema` URI
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -186,6 +194,7 @@ export const META_SCHEMA_URI_DRAFT_04 = "http://json-schema.org/draft-04/schema#
  * @see {@link META_SCHEMA_URI_DRAFT_04} for the Draft-04 `$schema` URI
  * @see {@link META_SCHEMA_URI_DRAFT_2020_12} for the Draft 2020-12 `$schema` URI
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -206,6 +215,7 @@ export const META_SCHEMA_URI_DRAFT_07 = "http://json-schema.org/draft-07/schema#
  *
  * @see {@link META_SCHEMA_URI_DRAFT_07} for the Draft-07 `$schema` URI
  *
+ * @stability stable
  * @category constants
  * @since 4.0.0
  */
@@ -276,6 +286,7 @@ const OPEN_API_31_TARGET_COLLISIONS = ["example", "discriminator", "xml", "exter
  * @see {@link fromSchemaDraft2020_12}
  * @see {@link fromSchemaOpenApi3_0}
  * @see {@link toDocumentDraft07}
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -313,6 +324,7 @@ export function fromSchemaDraft07(js: JsonSchema): Document<"draft-2020-12"> {
  *
  * @see {@link fromSchemaDraft07}
  * @see {@link fromSchemaOpenApi3_1}
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -365,6 +377,7 @@ export function fromSchemaDraft2020_12(js: JsonSchema): Document<"draft-2020-12"
  *
  * @see {@link fromSchemaOpenApi3_0}
  * @see {@link toMultiDocumentOpenApi3_1}
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -426,6 +439,7 @@ export function fromSchemaOpenApi3_1(js: JsonSchema): Document<"draft-2020-12">
  *
  * @see {@link fromSchemaOpenApi3_1}
  * @see {@link fromSchemaDraft07}
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -480,6 +494,7 @@ export function fromSchemaOpenApi3_0(schema: JsonSchema): Document<"draft-2020-1
  * @see {@link fromSchemaDraft07}
  * @see {@link toDocumentDraft04} for converting to Draft-04
  * @see {@link toMultiDocumentOpenApi3_1}
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -532,6 +547,7 @@ export function toDocumentDraft07(document: Document<"draft-2020-12">): Document
  * ```
  *
  * @see {@link toDocumentDraft07} for converting to Draft-07
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -592,6 +608,7 @@ export function toDocumentDraft04(document: Document<"draft-2020-12">): Document
  *
  * @see {@link toDocumentDraft07}
  * @see {@link MultiDocument}
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */

package/src/Latch.ts

@@ -5,6 +5,7 @@
  * includes effectful and synchronous constructors plus helpers to open, release,
  * close, wait, and gate effects behind the latch.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import type * as Effect from "./Effect.ts"
@@ -46,6 +47,7 @@ import * as internal from "./internal/effect.ts"
  * @see {@link open} for releasing current and future waiters
  * @see {@link release} for releasing only the current waiters
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -155,6 +157,7 @@ export interface Latch {
  *
  * @see {@link make} for creating a latch inside Effect code
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -190,6 +193,7 @@ export const makeUnsafe: (open?: boolean | undefined) => Latch = internal.makeLa
  *
  * @see {@link makeUnsafe} for synchronous allocation outside Effect code
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -210,6 +214,7 @@ export const make: (open?: boolean | undefined) => Effect.Effect<Latch> = intern
  * @see {@link openUnsafe} for a synchronous variant
  * @see {@link release} to release waiting fibers without opening the latch
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -233,6 +238,7 @@ export const open = (self: Latch): Effect.Effect<boolean> => self.open
  * @see {@link release} to release waiting fibers without opening the latch
  * @see {@link closeUnsafe} for the synchronous inverse operation
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -254,6 +260,7 @@ export const openUnsafe = (self: Latch): boolean => self.openUnsafe()
  *
  * @see {@link open} for opening the latch for current and future waiters
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -284,6 +291,7 @@ export {
    * @see {@link release} for resuming current waiters without opening the latch
    * @see {@link whenOpen} for waiting before running another effect
    *
+   * @stability stable
    * @category getters
    * @since 4.0.0
    */
@@ -306,6 +314,7 @@ export {
  * @see {@link closeUnsafe} for a synchronous variant
  * @see {@link open} for opening the latch for current and future waiters
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -330,6 +339,7 @@ export const close = (self: Latch): Effect.Effect<boolean> => self.close
  * @see {@link openUnsafe} to synchronously open the latch and release waiting
  * fibers
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -354,6 +364,7 @@ export const closeUnsafe = (self: Latch): boolean => self.closeUnsafe()
  * @see {@link open} for opening the latch for current and future waiters
  * @see {@link release} for resuming current waiters without opening the latch
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -377,6 +388,7 @@ export const whenOpen: {
    * @see {@link open} for opening the latch for current and future waiters
    * @see {@link release} for resuming current waiters without opening the latch
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -400,6 +412,7 @@ export const whenOpen: {
    * @see {@link open} for opening the latch for current and future waiters
    * @see {@link release} for resuming current waiters without opening the latch
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -420,6 +433,7 @@ export const whenOpen: {
  *
  * Use to check the state of the latch without suspending or changing its state.
  *
+ * @stability stable
  * @category predicates
  * @since 4.0.0
  */