effect 4.0.1 → 4.0.3

package/src/HKT.ts

@@ -7,6 +7,7 @@
  * mostly useful when defining generic helpers or type classes that should work
  * across several data types.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type * as Types from "./Types.ts"
@@ -47,6 +48,7 @@ import type * as Types from "./Types.ts"
  * const value: HKT.Kind<NonNullable<LinkedTypeLambda>, never, never, never, string> = identity.of("ok")
  * ```
  *
+ * @stability stable
  * @category symbols
  * @since 2.0.0
  */
@@ -89,6 +91,7 @@ export declare const URI: unique symbol
  * const witness: keyof Monad<HKT.TypeLambda> = "flatMap"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -134,6 +137,7 @@ export interface TypeClass<F extends TypeLambda> {
  * const witness: HKT.Kind<ArrayTypeLambda, never, never, never, string> = ["ok"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -199,6 +203,7 @@ export interface TypeLambda {
  * const witness: OptionString = Option.some("ok")
  * ```
  *
+ * @stability stable
  * @category utility types
  * @since 2.0.0
  */

package/src/Hash.ts

@@ -7,6 +7,7 @@
  * reference-based hashes, plus functions for combining and optimizing numeric
  * hash values.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import { dual } from "./Function.ts"
@@ -26,6 +27,7 @@ import { hasProperty } from "./Predicate.ts"
  * @see {@link isHash} for checking whether a value implements `Hash`
  * @see {@link hash} for computing hash values
  *
+ * @stability stable
  * @category symbols
  * @since 2.0.0
  */
@@ -59,6 +61,7 @@ export const symbol = "~effect/Hash"
  * new MyClass(42)[Hash.symbol]() // => 42
  * ```
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -98,6 +101,7 @@ export interface Hash {
  * Hash.hash([1, 2, 3]) === Hash.hash([1, 2, 3]) // => true
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -191,6 +195,7 @@ export const hash: <A>(self: A) => number = <A>(self: A) => {
  * typeof Hash.random(obj2) // => "number"
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -237,6 +242,7 @@ const mix = (h: number): number => {
  * @see {@link hash} for computing hash values from arbitrary inputs
  * @see {@link structureKeys} for hashing selected object fields without manual combination
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -268,6 +274,7 @@ export const combine: {
    * @see {@link hash} for computing hash values from arbitrary inputs
    * @see {@link structureKeys} for hashing selected object fields without manual combination
    *
+   * @stability stable
    * @category hashing
    * @since 2.0.0
    */
@@ -299,6 +306,7 @@ export const combine: {
    * @see {@link hash} for computing hash values from arbitrary inputs
    * @see {@link structureKeys} for hashing selected object fields without manual combination
    *
+   * @stability stable
    * @category hashing
    * @since 2.0.0
    */
@@ -325,6 +333,7 @@ export const combine: {
  * Hash.optimize(1234567890) // => 160826066
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -358,6 +367,7 @@ export const optimize = (n: number): number => (n & 0xbfffffff) | ((n >>> 1) & 0
  * Hash.isHash("string") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */
@@ -389,6 +399,7 @@ const float64 = new DataView(new ArrayBuffer(8))
  * Hash.number(100) === Hash.number(100) // => true
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -426,6 +437,7 @@ export const number = (n: number) => {
  * Hash.string("test") === Hash.string("test") // => true
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -468,6 +480,7 @@ export const string = (str: string) => {
  * hash1 === hash3 // => true
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -506,6 +519,7 @@ export const structureKeys = (o: object, keys: Iterable<PropertyKey>) => {
  * Hash.structure(obj1) === Hash.structure(obj3) // => true
  * ```
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */
@@ -550,6 +564,7 @@ const unordered = (seed: number, f: (el: any) => number) => (iter: Iterable<any>
  *
  * @see {@link hash} for the general-purpose hash dispatcher
  *
+ * @stability stable
  * @category hashing
  * @since 2.0.0
  */