@effect/platform 0.66.2 → 0.67.0

package/src/Command.ts

@@ -126,7 +126,19 @@ export const isCommand: (u: unknown) => u is Command = internal.isCommand
  * @category combinators
  */
 export const env: {
+  /**
+   * Specify the environment variables that will be used when running this command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (environment: Record<string, string | undefined>): (self: Command) => Command
+  /**
+   * Specify the environment variables that will be used when running this command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, environment: Record<string, string | undefined>): Command
 } = internal.env
 
@@ -146,7 +158,19 @@ export const exitCode: (self: Command) => Effect<ExitCode, PlatformError, Comman
  * @category combinators
  */
 export const feed: {
+  /**
+   * Feed a string to standard input (default encoding of UTF-8).
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: string): (self: Command) => Command
+  /**
+   * Feed a string to standard input (default encoding of UTF-8).
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, input: string): Command
 } = internal.feed
 
@@ -194,7 +218,31 @@ export const make: (command: string, ...args: Array<string>) => Command = intern
  * @category combinators
  */
 export const pipeTo: {
+  /**
+   * Pipe one command to another command from left to right.
+   *
+   * Conceptually, the equivalent of piping one shell command to another:
+   *
+   * ```sh
+   * command1 | command2
+   * ```
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (into: Command): (self: Command) => Command
+  /**
+   * Pipe one command to another command from left to right.
+   *
+   * Conceptually, the equivalent of piping one shell command to another:
+   *
+   * ```sh
+   * command1 | command2
+   * ```
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, into: Command): Command
 } = internal.pipeTo
 
@@ -206,7 +254,21 @@ export const pipeTo: {
  * @category combinators
  */
 export const runInShell: {
+  /**
+   * Allows for specifying whether or not a `Command` should be run inside a
+   * shell.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (shell: string | boolean): (self: Command) => Command
+  /**
+   * Allows for specifying whether or not a `Command` should be run inside a
+   * shell.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, shell: string | boolean): Command
 } = internal.runInShell
 
@@ -246,7 +308,25 @@ export const streamLines: (command: Command, encoding?: string) => Stream<string
  * @category execution
  */
 export const string: {
+  /**
+   * Runs the command returning the entire output as a string with the
+   * specified encoding.
+   *
+   * If an encoding is not specified, the encoding will default to `utf-8`.
+   *
+   * @since 1.0.0
+   * @category execution
+   */
   (encoding?: string): (command: Command) => Effect<string, PlatformError, CommandExecutor>
+  /**
+   * Runs the command returning the entire output as a string with the
+   * specified encoding.
+   *
+   * If an encoding is not specified, the encoding will default to `utf-8`.
+   *
+   * @since 1.0.0
+   * @category execution
+   */
   (command: Command, encoding?: string): Effect<string, PlatformError, CommandExecutor>
 } = internal.string
 
@@ -257,7 +337,19 @@ export const string: {
  * @category combinators
  */
 export const stderr: {
+  /**
+   * Specify the standard error stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (stderr: Command.Output): (self: Command) => Command
+  /**
+   * Specify the standard error stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, stderr: Command.Output): Command
 } = internal.stderr
 
@@ -268,7 +360,19 @@ export const stderr: {
  * @category combinators
  */
 export const stdin: {
+  /**
+   * Specify the standard input stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (stdin: Command.Input): (self: Command) => Command
+  /**
+   * Specify the standard input stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, stdin: Command.Input): Command
 } = internal.stdin
 
@@ -279,7 +383,19 @@ export const stdin: {
  * @category combinators
  */
 export const stdout: {
+  /**
+   * Specify the standard output stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (stdout: Command.Output): (self: Command) => Command
+  /**
+   * Specify the standard output stream for a command.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, stdout: Command.Output): Command
 } = internal.stdout
 
@@ -293,6 +409,24 @@ export const stdout: {
  * @category combinators
  */
 export const workingDirectory: {
+  /**
+   * Set the working directory that will be used when this command will be run.
+   *
+   * For piped commands, the working directory of each command will be set to the
+   * specified working directory.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (cwd: string): (self: Command) => Command
+  /**
+   * Set the working directory that will be used when this command will be run.
+   *
+   * For piped commands, the working directory of each command will be set to the
+   * specified working directory.
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Command, cwd: string): Command
 } = internal.workingDirectory

package/src/Cookies.ts

@@ -377,11 +377,20 @@ export const unsafeMakeCookie = (
  * @category combinators
  */
 export const setCookie: {
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (cookie: Cookie): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    cookie: Cookie
-  ): Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, cookie: Cookie): Cookies
 } = dual(
   2,
   (self: Cookies, cookie: Cookie) =>
@@ -399,11 +408,20 @@ export const setCookie: {
  * @category combinators
  */
 export const setAllCookie: {
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (cookies: Iterable<Cookie>): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    cookies: Iterable<Cookie>
-  ): Cookies
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, cookies: Iterable<Cookie>): Cookies
 } = dual(2, (self: Cookies, cookies: Iterable<Cookie>) => {
   const record = { ...self.cookies }
   for (const cookie of cookies) {
@@ -419,11 +437,20 @@ export const setAllCookie: {
  * @category combinators
  */
 export const merge: {
+  /**
+   * Combine two Cookies objects, removing duplicates from the first
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (that: Cookies): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    that: Cookies
-  ): Cookies
+  /**
+   * Combine two Cookies objects, removing duplicates from the first
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, that: Cookies): Cookies
 } = dual(2, (self: Cookies, that: Cookies) =>
   fromReadonlyRecord({
     ...self.cookies,
@@ -437,11 +464,20 @@ export const merge: {
  * @category combinators
  */
 export const remove: {
+  /**
+   * Remove a cookie by name
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    name: string
-  ): Cookies
+  /**
+   * Remove a cookie by name
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string): Cookies
 } = dual(2, (self: Cookies, name: string) => fromReadonlyRecord(Record.remove(self.cookies, name)))
 
 /**
@@ -451,7 +487,19 @@ export const remove: {
  * @category combinators
  */
 export const get: {
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Option.Option<Cookie>
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Cookies, name: string): Option.Option<Cookie>
 } = dual(
   (args) => isCookies(args[0]),
@@ -465,7 +513,19 @@ export const get: {
  * @category combinators
  */
 export const getValue: {
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: Cookies) => Option.Option<string>
+  /**
+   * Get a cookie from a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Cookies, name: string): Option.Option<string>
 } = dual(
   (args) => isCookies(args[0]),
@@ -480,17 +540,20 @@ export const getValue: {
  * @category combinators
  */
 export const set: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (self: Cookies) => Either.Either<Cookies, CookiesError>
-  (
-    self: Cookies,
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): Either.Either<Cookies, CookiesError>
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Either.Either<Cookies, CookiesError>
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Either.Either<Cookies, CookiesError>
 } = dual(
   (args) => isCookies(args[0]),
   (self: Cookies, name: string, value: string, options?: Cookie["options"]) =>
@@ -507,17 +570,20 @@ export const set: {
  * @category combinators
  */
 export const unsafeSet: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (self: Cookies) => Cookies
-  (
-    self: Cookies,
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (self: Cookies) => Cookies
+  /**
+   * Add a cookie to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Cookies, name: string, value: string, options?: Cookie["options"]): Cookies
 } = dual(
   (args) => isCookies(args[0]),
   (self: Cookies, name: string, value: string, options?: Cookie["options"]) =>
@@ -535,9 +601,21 @@ export const unsafeSet: {
  * @category combinators
  */
 export const setAll: {
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
   ): (self: Cookies) => Either.Either<Cookies, CookiesError>
+  /**
+   * Add multiple cookies to a Cookies object
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: Cookies,
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
@@ -567,9 +645,21 @@ export const setAll: {
  * @category combinators
  */
 export const unsafeSetAll: {
+  /**
+   * Add multiple cookies to a Cookies object, throwing an error if invalid
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>
   ): (self: Cookies) => Cookies
+  /**
+   * Add multiple cookies to a Cookies object, throwing an error if invalid
+   *
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: Cookies,
     cookies: Iterable<readonly [name: string, value: string, options?: Cookie["options"]]>

package/src/Effectify.ts

@@ -244,11 +244,20 @@ export type EffectifyError<T> = T extends {
  * @since 1.0.0
  */
 export const effectify: {
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any>(fn: F): Effectify<F, EffectifyError<F>>
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any, E>(
     fn: F,
     onError: (error: EffectifyError<F>, args: Parameters<F>) => E
   ): Effectify<F, E>
+  /**
+   * @since 1.0.0
+   */
   <F extends (...args: Array<any>) => any, E, E2>(
     fn: F,
     onError: (error: EffectifyError<F>, args: Parameters<F>) => E,

package/src/Headers.ts

@@ -117,10 +117,26 @@ export const unsafeFromRecord = (input: Record.ReadonlyRecord<string, string>):
  * @category combinators
  */
 export const has: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => boolean
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): boolean
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => boolean,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => boolean
 >(2, (self, key) => key.toLowerCase() in self)
 
@@ -129,10 +145,26 @@ export const has: {
  * @category combinators
  */
 export const get: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => Option.Option<string>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): Option.Option<string>
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => Option.Option<string>,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => Option.Option<string>
 >(2, (self, key) => Record.get(self as Record<string, string>, key.toLowerCase()))
 
@@ -141,10 +173,26 @@ export const get: {
  * @category combinators
  */
 export const set: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string, value: string): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string, value: string) => Headers
 >(3, (self, key, value) => {
   const out = make(self)
@@ -157,10 +205,26 @@ export const set: {
  * @category combinators
  */
 export const setAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Input): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Input): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Input) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Input) => Headers
 >(2, (self, headers) =>
   make({
@@ -173,10 +237,26 @@ export const setAll: {
  * @category combinators
  */
 export const merge: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Headers): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Headers): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (headers: Headers) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, headers: Headers) => Headers
 >(2, (self, headers) => {
   const out = make(self)
@@ -189,10 +269,26 @@ export const merge: {
  * @category combinators
  */
 export const remove: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: Headers) => Headers
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string): Headers
 } = dual<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string) => (self: Headers) => Headers,
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: Headers, key: string) => Headers
 >(2, (self, key) => {
   const out = make(self)
@@ -205,13 +301,16 @@ export const remove: {
  * @category combinators
  */
 export const redact: {
-  (
-    key: string | RegExp | ReadonlyArray<string | RegExp>
-  ): (self: Headers) => Record<string, string | Redacted.Redacted>
-  (
-    self: Headers,
-    key: string | RegExp | ReadonlyArray<string | RegExp>
-  ): Record<string, string | Redacted.Redacted>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (key: string | RegExp | ReadonlyArray<string | RegExp>): (self: Headers) => Record<string, string | Redacted.Redacted>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (self: Headers, key: string | RegExp | ReadonlyArray<string | RegExp>): Record<string, string | Redacted.Redacted>
 } = dual(
   2,
   (