effect 4.0.0-beta.4 → 4.0.0-beta.41

package/src/String.ts

@@ -10,6 +10,7 @@ import * as Equ from "./Equivalence.ts"
 import { dual } from "./Function.ts"
 import * as readonlyArray from "./internal/array.ts"
 import * as number from "./Number.ts"
+import * as Option from "./Option.ts"
 import * as order from "./Order.ts"
 import type * as Ordering from "./Ordering.ts"
 import type { Refinement } from "./Predicate.ts"
@@ -534,15 +535,15 @@ export const endsWith = (searchString: string, position?: number) => (self: stri
   self.endsWith(searchString, position)
 
 /**
- * Returns the character code at the specified index, or `undefined` if the index is out of bounds.
+ * Returns the character code at the specified index, or `None` if the index is out of bounds.
  *
  * **Example**
  *
  * ```ts
  * import { String } from "effect"
  *
- * String.charCodeAt("abc", 1) // 98
- * String.charCodeAt("abc", 4) // undefined
+ * String.charCodeAt("abc", 1) // Option.some(98)
+ * String.charCodeAt("abc", 4) // Option.none()
  * ```
  *
  * @category elements
@@ -550,43 +551,41 @@ export const endsWith = (searchString: string, position?: number) => (self: stri
  */
 export const charCodeAt: {
   /**
-   * Returns the character code at the specified index, or `undefined` if the index is out of bounds.
+   * Returns the character code at the specified index, or `None` if the index is out of bounds.
    *
    * **Example**
    *
    * ```ts
    * import { String } from "effect"
    *
-   * String.charCodeAt("abc", 1) // 98
-   * String.charCodeAt("abc", 4) // undefined
+   * String.charCodeAt("abc", 1) // Option.some(98)
+   * String.charCodeAt("abc", 4) // Option.none()
    * ```
    *
    * @category elements
    * @since 2.0.0
    */
-  (index: number): (self: string) => number | undefined
+  (index: number): (self: string) => Option.Option<number>
   /**
-   * Returns the character code at the specified index, or `undefined` if the index is out of bounds.
+   * Returns the character code at the specified index, or `None` if the index is out of bounds.
    *
    * **Example**
    *
    * ```ts
    * import { String } from "effect"
    *
-   * String.charCodeAt("abc", 1) // 98
-   * String.charCodeAt("abc", 4) // undefined
+   * String.charCodeAt("abc", 1) // Option.some(98)
+   * String.charCodeAt("abc", 4) // Option.none()
    * ```
    *
    * @category elements
    * @since 2.0.0
    */
-  (self: string, index: number): number | undefined
+  (self: string, index: number): Option.Option<number>
 } = dual(
   2,
-  (self: string, index: number): number | undefined => {
-    const out = self.charCodeAt(index)
-    return isNaN(out) ? undefined : out
-  }
+  (self: string, index: number): Option.Option<number> =>
+    Option.filter(Option.some(self.charCodeAt(index)), (charCode) => !isNaN(charCode))
 )
 
 /**
@@ -607,23 +606,54 @@ export const charCodeAt: {
 export const substring = (start: number, end?: number) => (self: string): string => self.substring(start, end)
 
 /**
- * A `pipe`-able version of the native `charAt` method.
+ * Returns the character at the specified index, or `None` if the index is out of bounds.
  *
  * **Example**
  *
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("abc", String.at(1)) // "b"
- * pipe("abc", String.at(4)) // undefined
+ * pipe("abc", String.at(1)) // Option.some("b")
+ * pipe("abc", String.at(4)) // Option.none()
  * ```
  *
  * @category elements
  * @since 2.0.0
  */
-export const at = (index: number) => (self: string): string | undefined => {
-  return self.charAt(index)
-}
+export const at: {
+  /**
+   * Returns the character at the specified index, or `None` if the index is out of bounds.
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { pipe, String } from "effect"
+   *
+   * pipe("abc", String.at(1)) // Option.some("b")
+   * pipe("abc", String.at(4)) // Option.none()
+   * ```
+   *
+   * @category elements
+   * @since 2.0.0
+   */
+  (index: number): (self: string) => Option.Option<string>
+  /**
+   * Returns the character at the specified index, or `None` if the index is out of bounds.
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { pipe, String } from "effect"
+   *
+   * pipe("abc", String.at(1)) // Option.some("b")
+   * pipe("abc", String.at(4)) // Option.none()
+   * ```
+   *
+   * @category elements
+   * @since 2.0.0
+   */
+  (self: string, index: number): Option.Option<string>
+} = dual(2, (self: string, index: number): Option.Option<string> => Option.fromUndefinedOr(self.at(index)))
 
 /**
  * Returns the character at the specified index, or `None` if the index is out of bounds.
@@ -633,8 +663,8 @@ export const at = (index: number) => (self: string): string | undefined => {
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("abc", String.charAt(1)) // "b"
- * pipe("abc", String.charAt(4)) // undefined
+ * pipe("abc", String.charAt(1)) // Option.some("b")
+ * pipe("abc", String.charAt(4)) // Option.none()
  * ```
  *
  * @category elements
@@ -649,14 +679,14 @@ export const charAt: {
    * ```ts
    * import { pipe, String } from "effect"
    *
-   * pipe("abc", String.charAt(1)) // "b"
-   * pipe("abc", String.charAt(4)) // undefined
+   * pipe("abc", String.charAt(1)) // Option.some("b")
+   * pipe("abc", String.charAt(4)) // Option.none()
    * ```
    *
    * @category elements
    * @since 2.0.0
    */
-  (index: number): (self: string) => string | undefined
+  (index: number): (self: string) => Option.Option<string>
   /**
    * Returns the character at the specified index, or `None` if the index is out of bounds.
    *
@@ -665,40 +695,68 @@ export const charAt: {
    * ```ts
    * import { pipe, String } from "effect"
    *
-   * pipe("abc", String.charAt(1)) // "b"
-   * pipe("abc", String.charAt(4)) // undefined
+   * pipe("abc", String.charAt(1)) // Option.some("b")
+   * pipe("abc", String.charAt(4)) // Option.none()
    * ```
    *
    * @category elements
    * @since 2.0.0
    */
-  (self: string, index: number): string | undefined
+  (self: string, index: number): Option.Option<string>
 } = dual(
   2,
-  (self: string, index: number): string | undefined => {
-    const out = self.charAt(index)
-    return isNonEmpty(out) ? out : undefined
-  }
+  (self: string, index: number): Option.Option<string> => Option.filter(Option.some(self.charAt(index)), isNonEmpty)
 )
 
 /**
- * A `pipe`-able version of the native `codePointAt` method.
+ * Returns the Unicode code point at the specified index, or `None` if the index is out of bounds.
  *
  * **Example**
  *
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("abc", String.codePointAt(1)) // 98
- * pipe("abc", String.codePointAt(10)) // undefined
+ * pipe("abc", String.codePointAt(1)) // Option.some(98)
+ * pipe("abc", String.codePointAt(10)) // Option.none()
  * ```
  *
  * @category elements
  * @since 2.0.0
  */
-export const codePointAt = (index: number) => (self: string): number | undefined => {
-  return self.codePointAt(index)
-}
+export const codePointAt: {
+  /**
+   * Returns the Unicode code point at the specified index, or `None` if the index is out of bounds.
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { pipe, String } from "effect"
+   *
+   * pipe("abc", String.codePointAt(1)) // Option.some(98)
+   * pipe("abc", String.codePointAt(10)) // Option.none()
+   * ```
+   *
+   * @category elements
+   * @since 2.0.0
+   */
+  (index: number): (self: string) => Option.Option<number>
+  /**
+   * Returns the Unicode code point at the specified index, or `None` if the index is out of bounds.
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { pipe, String } from "effect"
+   *
+   * pipe("abc", String.codePointAt(1)) // Option.some(98)
+   * pipe("abc", String.codePointAt(10)) // Option.none()
+   * ```
+   *
+   * @category elements
+   * @since 2.0.0
+   */
+  (self: string, index: number): Option.Option<number>
+} = dual(2, (self: string, index: number): Option.Option<number> => Option.fromUndefinedOr(self.codePointAt(index)))
 
 /**
  * Returns the index of the first occurrence of a substring, or `None` if not found.
@@ -708,17 +766,15 @@ export const codePointAt = (index: number) => (self: string): number | undefined
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("abbbc", String.indexOf("b")) // 1
- * pipe("abbbc", String.indexOf("z")) // undefined
+ * pipe("abbbc", String.indexOf("b")) // Option.some(1)
+ * pipe("abbbc", String.indexOf("z")) // Option.none()
  * ```
  *
  * @category searching
  * @since 2.0.0
  */
-export const indexOf = (searchString: string) => (self: string): number | undefined => {
-  const out = self.indexOf(searchString)
-  return out >= 0 ? out : undefined
-}
+export const indexOf = (searchString: string) => (self: string): Option.Option<number> =>
+  Option.filter(Option.some(self.indexOf(searchString)), number.isGreaterThanOrEqualTo(0))
 
 /**
  * Returns the index of the last occurrence of a substring, or `None` if not found.
@@ -728,17 +784,15 @@ export const indexOf = (searchString: string) => (self: string): number | undefi
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("abbbc", String.lastIndexOf("b")) // 3
- * pipe("abbbc", String.lastIndexOf("d")) // undefined
+ * pipe("abbbc", String.lastIndexOf("b")) // Option.some(3)
+ * pipe("abbbc", String.lastIndexOf("d")) // Option.none()
  * ```
  *
  * @category searching
  * @since 2.0.0
  */
-export const lastIndexOf = (searchString: string) => (self: string): number | undefined => {
-  const out = self.lastIndexOf(searchString)
-  return out >= 0 ? out : undefined
-}
+export const lastIndexOf = (searchString: string) => (self: string): Option.Option<number> =>
+  Option.filter(Option.some(self.lastIndexOf(searchString)), number.isGreaterThanOrEqualTo(0))
 
 /**
  * Compares two strings according to the current locale.
@@ -768,14 +822,15 @@ export const localeCompare =
  * ```ts
  * import { pipe, String } from "effect"
  *
- * pipe("hello", String.match(/l+/)) // ["ll"]
- * pipe("hello", String.match(/x/)) // null
+ * pipe("hello", String.match(/l+/)) // Option.some(["ll"])
+ * pipe("hello", String.match(/x/)) // Option.none()
  * ```
  *
  * @category searching
  * @since 2.0.0
  */
-export const match = (regExp: RegExp | string) => (self: string): RegExpMatchArray | null => self.match(regExp)
+export const match = (regExp: RegExp | string) => (self: string): Option.Option<RegExpMatchArray> =>
+  Option.fromNullOr(self.match(regExp))
 
 /**
  * It is the `pipe`-able version of the native `matchAll` method.
@@ -896,9 +951,9 @@ export const replaceAll = (searchValue: string | RegExp, replaceValue: string) =
  * ```ts
  * import { String } from "effect"
  *
- * String.search("ababb", "b") // 1
- * String.search("ababb", "/abb/") // 2
- * String.search("ababb", "d") // undefined
+ * String.search("ababb", "b") // Option.some(1)
+ * String.search("ababb", /abb/) // Option.some(2)
+ * String.search("ababb", "d") // Option.none()
  * ```
  *
  * @category searching
@@ -913,15 +968,15 @@ export const search: {
    * ```ts
    * import { String } from "effect"
    *
-   * String.search("ababb", "b") // 1
-   * String.search("ababb", "/abb/") // 2
-   * String.search("ababb", "d") // undefined
+   * String.search("ababb", "b") // Option.some(1)
+   * String.search("ababb", /abb/) // Option.some(2)
+   * String.search("ababb", "d") // Option.none()
    * ```
    *
    * @category searching
    * @since 2.0.0
    */
-  (regExp: RegExp | string): (self: string) => number | undefined
+  (regExp: RegExp | string): (self: string) => Option.Option<number>
   /**
    * Searches for a match between a regular expression and the string.
    *
@@ -930,21 +985,19 @@ export const search: {
    * ```ts
    * import { String } from "effect"
    *
-   * String.search("ababb", "b") // 1
-   * String.search("ababb", "/abb/") // 2
-   * String.search("ababb", "d") // undefined
+   * String.search("ababb", "b") // Option.some(1)
+   * String.search("ababb", /abb/) // Option.some(2)
+   * String.search("ababb", "d") // Option.none()
    * ```
    *
    * @category searching
    * @since 2.0.0
    */
-  (self: string, regExp: RegExp | string): number | undefined
+  (self: string, regExp: RegExp | string): Option.Option<number>
 } = dual(
   2,
-  (self: string, regExp: RegExp | string): number | undefined => {
-    const out = self.search(regExp)
-    return out >= 0 ? out : undefined
-  }
+  (self: string, regExp: RegExp | string): Option.Option<number> =>
+    Option.filter(Option.some(self.search(regExp)), number.isGreaterThanOrEqualTo(0))
 )
 
 /**

package/src/Struct.ts

@@ -157,7 +157,7 @@ export type Mutable<T> = { -readonly [K in keyof T]: T[K] } & {}
  * @category Type-Level Programming
  * @since 4.0.0
  */
-export type Assign<T, U> = keyof T & keyof U extends never ? T & U : Omit<T, keyof T & keyof U> & U
+export type Assign<T, U> = Simplify<keyof T & keyof U extends never ? T & U : Omit<T, keyof T & keyof U> & U>
 
 /**
  * Retrieves the value at `key` from a struct.
@@ -305,7 +305,7 @@ export const pick: {
    * @category filtering
    * @since 2.0.0
    */
-  <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): (self: S) => Pick<S, Keys[number]>
+  <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): (self: S) => Simplify<Pick<S, Keys[number]>>
   /**
    * Creates a new struct containing only the specified keys.
    *
@@ -329,7 +329,7 @@ export const pick: {
    * @category filtering
    * @since 2.0.0
    */
-  <S extends object, const Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys): Pick<S, Keys[number]>
+  <S extends object, const Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys): Simplify<Pick<S, Keys[number]>>
 } = dual(
   2,
   <S extends object, const Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys) => {
@@ -382,7 +382,7 @@ export const omit: {
    * @category filtering
    * @since 2.0.0
    */
-  <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): (self: S) => Omit<S, Keys[number]>
+  <S extends object, const Keys extends ReadonlyArray<keyof S>>(keys: Keys): (self: S) => Simplify<Omit<S, Keys[number]>>
   /**
    * Creates a new struct with the specified keys removed.
    *
@@ -405,7 +405,7 @@ export const omit: {
    * @category filtering
    * @since 2.0.0
    */
-  <S extends object, const Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys): Omit<S, Keys[number]>
+  <S extends object, const Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys): Simplify<Omit<S, Keys[number]>>
 } = dual(
   2,
   <S extends object, Keys extends ReadonlyArray<keyof S>>(self: S, keys: Keys) => {
@@ -464,7 +464,7 @@ export const assign: {
    * @category combining
    * @since 4.0.0
    */
-  <O extends object>(that: O): <S extends object>(self: S) => Simplify<Assign<S, O>>
+  <O extends object>(that: O): <S extends object>(self: S) => Assign<S, O>
   /**
    * Merges two structs into a new struct. When both structs share a key, the
    * value from `that` (the second struct) wins.
@@ -490,7 +490,7 @@ export const assign: {
    * @category combining
    * @since 4.0.0
    */
-  <O extends object, S extends object>(self: S, that: O): Simplify<Assign<S, O>>
+  <O extends object, S extends object>(self: S, that: O): Assign<S, O>
 } = dual(
   2,
   <O extends object, S extends object>(self: S, that: O) => {
@@ -1513,3 +1513,29 @@ export function makeReducer<A>(
   }
   return Reducer.make(combine, initialValue)
 }
+
+/**
+ * Creates a record with the given keys and value.
+ *
+ * **Example** (Creating a record)
+ *
+ * ```ts
+ * import { Struct } from "effect"
+ *
+ * const record = Struct.Record(["a", "b"], "value")
+ * console.log(record) // { a: "value", b: "value" }
+ * ```
+ *
+ * @category Constructors
+ * @since 4.0.0
+ */
+export function Record<const Keys extends ReadonlyArray<string | symbol>, Value>(
+  keys: Keys,
+  value: Value
+): Record<Keys[number], Value> {
+  const out: any = {}
+  for (const key of keys) {
+    out[key] = value
+  }
+  return out
+}