functionalscript 0.11.2 → 0.11.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "functionalscript",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "type": "module",
   "files": [
     "**/*.js",

package/text/sgr/module.f.d.ts

@@ -21,17 +21,40 @@ export declare const csi: (end: End) => Csi;
  * https://en.wikipedia.org/wiki/ANSI_escape_code#SGR
  */
 export declare const sgr: Csi;
+/** Resets all SGR styles to terminal defaults. */
 export declare const reset: string;
+/** Enables bold/intense text rendering when supported by the terminal. */
 export declare const bold: string;
+/** Applies red foreground color to subsequent text. */
 export declare const fgRed: string;
+/** Applies green foreground color to subsequent text. */
 export declare const fgGreen: string;
 export type Stdout = {
+    /** Writes a string to the output stream. */
     readonly write: (s: string) => void;
 };
+/** Stateful writer that updates previously printed text in-place. */
 export type WriteText = (text: string) => WriteText;
+/**
+ * Creates a stateful text writer that rewrites the previous value using backspaces.
+ *
+ * @param stdout - Destination output stream.
+ * @returns A recursive writer that replaces prior text on each call.
+ */
 export declare const createConsoleText: (stdout: Stdout) => WriteText;
 export type CsiConsole = (s: string) => void;
+/**
+ * Creates a TTY-aware console function.
+ *
+ * For TTY destinations, ANSI SGR sequences are preserved.
+ * For non-TTY destinations, ANSI SGR sequences are stripped.
+ *
+ * @param io - Runtime IO bindings.
+ * @returns A function that targets a writable stream.
+ */
 export declare const console: ({ fs: { writeSync } }: Io) => (w: Writable) => CsiConsole;
+/** Writes to process stdout using a TTY-aware CSI console. */
 export declare const stdio: (io: Io) => CsiConsole;
+/** Writes to process stderr using a TTY-aware CSI console. */
 export declare const stderr: (io: Io) => CsiConsole;
 export {};

package/text/sgr/module.f.js

@@ -19,9 +19,13 @@ export const csi = (end) => code => `${begin}${code.toString()}${end}`;
  * https://en.wikipedia.org/wiki/ANSI_escape_code#SGR
  */
 export const sgr = csi('m');
+/** Resets all SGR styles to terminal defaults. */
 export const reset = sgr(0);
+/** Enables bold/intense text rendering when supported by the terminal. */
 export const bold = sgr(1);
+/** Applies red foreground color to subsequent text. */
 export const fgRed = sgr(31);
+/** Applies green foreground color to subsequent text. */
 export const fgGreen = sgr(32);
 const { max } = Math;
 const replace = (old) => (text) => {
@@ -29,6 +33,12 @@ const replace = (old) => (text) => {
     const suffixLength = max(0, len - text.length);
     return backspace.repeat(len) + text + " ".repeat(suffixLength) + backspace.repeat(suffixLength);
 };
+/**
+ * Creates a stateful text writer that rewrites the previous value using backspaces.
+ *
+ * @param stdout - Destination output stream.
+ * @returns A recursive writer that replaces prior text on each call.
+ */
 export const createConsoleText = (stdout) => {
     const f = (old) => (text) => {
         stdout.write(replace(old)(text));
@@ -36,11 +46,22 @@ export const createConsoleText = (stdout) => {
     };
     return f('');
 };
+/**
+ * Creates a TTY-aware console function.
+ *
+ * For TTY destinations, ANSI SGR sequences are preserved.
+ * For non-TTY destinations, ANSI SGR sequences are stripped.
+ *
+ * @param io - Runtime IO bindings.
+ * @returns A function that targets a writable stream.
+ */
 export const console = ({ fs: { writeSync } }) => (w) => {
     const { isTTY } = w;
     return isTTY
         ? (s) => writeSync(w.fd, s + '\n')
         : (s) => writeSync(w.fd, s.replace(/\x1b\[[0-9;]*m/g, '') + '\n');
 };
+/** Writes to process stdout using a TTY-aware CSI console. */
 export const stdio = (io) => console(io)(io.process.stdout);
+/** Writes to process stderr using a TTY-aware CSI console. */
 export const stderr = (io) => console(io)(io.process.stderr);

package/types/effects/module.f.d.ts

@@ -16,10 +16,14 @@ export type DoK<O extends Operation, T, K extends O[0]> = DoKPR<O, T, K, Pr<O, K
 export type Do<O extends Operation, T> = DoK<O, T, O[0]>;
 export declare const pure: <T>(v: T) => Effect<never, T>;
 export declare const doFull: <O extends Operation, T, K extends O[0]>(cmd: K, param: Pr<O, K>[0], cont: (input: Pr<O, K>[1]) => Effect<O, T>) => Effect<O, T>;
-export declare const do_: <O extends Operation>(cmd: O[0]) => (param: Pr<O, O[0]>[0]) => Effect<O, Pr<O, O[0]>[1]>;
+export type Param<O extends Operation> = F<O>[0];
+export type Return<O extends Operation> = F<O>[1];
+export declare const do_: <O extends Operation>(cmd: O[0]) => (param: Param<O>) => Effect<O, Return<O>>;
+export declare const doRest: <O extends Operation>(cmd: O[0]) => (...param: Param<O>) => Effect<O, Return<O>>;
 export declare const begin: Effect<never, void>;
 export type ToAsyncOperationMap<O extends Operation> = {
     readonly [K in O[0]]: (payload: Pr<O, K>[0]) => Promise<Pr<O, K>[1]>;
 };
 export type F<O extends Operation> = Pr<O, O[0]>;
-export type Func<O extends Operation> = (_: F<O>[0]) => Effect<O, F<O>[1]>;
+export type Func<O extends Operation> = (_: Param<O>) => Effect<O, Return<O>>;
+export type RestFunc<O extends Operation> = (..._: Param<O>) => Effect<O, Return<O>>;

package/types/effects/module.f.js

@@ -12,4 +12,5 @@ export const doFull = (cmd, param, cont) => ({
     step: (f) => doFull(cmd, param, x => cont(x).step(f)),
 });
 export const do_ = (cmd) => (param) => doFull(cmd, param, pure);
+export const doRest = (cmd) => (...param) => do_(cmd)(param);
 export const begin = pure(undefined);

package/types/effects/node/module.f.d.ts

@@ -1,7 +1,7 @@
 import type { Vec } from '../../bit_vec/module.f.ts';
 import type { Nominal } from '../../nominal/module.f.ts';
 import type { Result } from '../../result/module.f.ts';
-import { type Effect, type Func, type Operation, type ToAsyncOperationMap } from '../module.f.ts';
+import { type Effect, type Func, type Operation, type RestFunc, type ToAsyncOperationMap } from '../module.f.ts';
 export type IoResult<T> = Result<T, unknown>;
 export type All = ['all', <T>(_: readonly Effect<never, T>[]) => readonly T[]];
 /**
@@ -20,7 +20,7 @@ export type MakeDirectoryOptions = {
 };
 export type MkdirParam = readonly [string, MakeDirectoryOptions?];
 export type Mkdir = readonly ['mkdir', (_: MkdirParam) => IoResult<void>];
-export declare const mkdir: (...p: MkdirParam) => Effect<Mkdir, IoResult<void>>;
+export declare const mkdir: RestFunc<Mkdir>;
 export type ReadFile = readonly ['readFile', (_: string) => IoResult<Vec>];
 export declare const readFile: Func<ReadFile>;
 /**
@@ -37,10 +37,10 @@ export type ReaddirOptions = {
 };
 export type ReaddirParam = readonly [string, ReaddirOptions];
 export type Readdir = readonly ['readdir', (_: ReaddirParam) => IoResult<readonly Dirent[]>];
-export declare const readdir: (...p: ReaddirParam) => Effect<Readdir, IoResult<readonly Dirent[]>>;
+export declare const readdir: RestFunc<Readdir>;
 export type WriteFileParam = readonly [string, Vec];
 export type WriteFile = readonly ['writeFile', (_: WriteFileParam) => IoResult<void>];
-export declare const writeFile: (...p: WriteFileParam) => Effect<WriteFile, IoResult<void>>;
+export declare const writeFile: RestFunc<WriteFile>;
 export type Fs = Mkdir | ReadFile | Readdir | WriteFile;
 export type Error = ['error', (_: string) => void];
 export declare const error: Func<Error>;
@@ -54,6 +54,7 @@ export type RequestListener = (_: IncomingMessage) => ServerResponse;
 export type CreateServer = ['createServer', (_: RequestListener) => Server];
 export declare const createServer: Func<CreateServer>;
 export type Listen = ['listen', (_: readonly [Server, number]) => void];
+export declare const listen: RestFunc<Listen>;
 export type Http = CreateServer | Listen;
 export type NodeOp = All | Fetch | Console | Fs | Http;
 export type NodeEffect<T> = Effect<NodeOp, T>;

package/types/effects/node/module.f.js

@@ -1,4 +1,4 @@
-import { do_ } from "../module.f.js";
+import { doRest, do_ } from "../module.f.js";
 /**
  * To run the operation `O` should be known by the runner/engine.
  * This is the reason why we merge `O` with `All` in the resulted `Effect`.
@@ -9,10 +9,11 @@ import { do_ } from "../module.f.js";
 export const all = (...a) => do_('all')(a);
 export const both = (a) => (b) => all(a, b);
 export const fetch = do_('fetch');
-export const mkdir = (...p) => do_('mkdir')(p);
+export const mkdir = doRest('mkdir');
 export const readFile = do_('readFile');
-export const readdir = (...p) => do_('readdir')(p);
-export const writeFile = (...p) => do_('writeFile')(p);
+export const readdir = doRest('readdir');
+export const writeFile = doRest('writeFile');
 export const error = do_('error');
 export const log = do_('log');
 export const createServer = do_('createServer');
+export const listen = doRest('listen');