@flex-development/mlly 1.0.0-beta.3 → 1.0.0-beta.4

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [1.0.0-beta.4](https://github.com/flex-development/mlly/compare/1.0.0-beta.3...1.0.0-beta.4) (2026-02-06)
+
+### ⚠ BREAKING CHANGES
+
+- **ts:** pass type parameters to fs methods
+
+### :package: Build
+
+- [[`77f0333`](https://github.com/flex-development/mlly/commit/77f0333d3f83eec60d0ee41270d36bd7ac5828a4)] **deps-dev:** Bump @faker-js/faker from 10.2.0 to 10.3.0 ([#966](https://github.com/flex-development/mlly/issues/966))
+- [[`d71a814`](https://github.com/flex-development/mlly/commit/d71a8145cd3773743411d70e84742ec93838af16)] **deps-dev:** Bump cspell from 9.6.3 to 9.6.4 ([#965](https://github.com/flex-development/mlly/issues/965))
+- [[`4f6f9c3`](https://github.com/flex-development/mlly/commit/4f6f9c3fb24a41ce22031a35345c8b85f16ef732)] **deps-dev:** Bump msw from 2.12.7 to 2.12.8 ([#964](https://github.com/flex-development/mlly/issues/964))
+- [[`b08edac`](https://github.com/flex-development/mlly/commit/b08edac9f21e7c91ca554e8938bba0b814605e7d)] **deps-dev:** bump msw from 2.12.8 to 2.12.9
+- [[`893c030`](https://github.com/flex-development/mlly/commit/893c030d8d438871ad94b29a786eb59fa144a571)] **deps:** Bump @isaacs/brace-expansion from 5.0.0 to 5.0.1 ([#963](https://github.com/flex-development/mlly/issues/963))
+
+### :mechanical_arm: Refactors
+
+- [[`cc5109c`](https://github.com/flex-development/mlly/commit/cc5109cc76949d287f1b53e54e47559ed1a902b3)] **ts:** pass type parameters to fs methods
+
 ## [1.0.0-beta.3](https://github.com/flex-development/mlly/compare/1.0.0-beta.2...1.0.0-beta.3) (2026-02-03)
 
 ### ⚠ BREAKING CHANGES
@@ -1278,3 +1296,4 @@
 
 
 
+

package/README.md

@@ -87,11 +87,11 @@
   - [`PatternMatch`](#patternmatch)
   - [`ProtocolMap`](#protocolmap)
   - [`Protocol`](#protocol)
-  - [`ReadFile<[T]>`](#readfilet)
-  - [`Realpath<[T]>`](#realpatht)
+  - [`ReadFile`](#readfile)
+  - [`Realpath`](#realpath)
   - [`ResolveAliasOptions`](#resolvealiasoptions)
   - [`ResolveModuleOptions`](#resolvemoduleoptions)
-  - [`Stat<[T]>`](#statt)
+  - [`Stat`](#stat)
   - [`Stats`](#stats)
 - Additional Documentation
   - [Resolution Algorithm](./docs/resolution-algorithm.md)
@@ -1174,11 +1174,11 @@ The file system API (`interface`).
 
 #### Properties
 
-- `readFile` ([`ReadFile`](#readfilet))
+- `readFile` ([`ReadFile`](#readfile))
   — read the entire contents of a file
-- `realpath` ([`Realpath`](#realpatht))
+- `realpath` ([`Realpath`](#realpath))
   — compute a canonical pathname by resolving `.`, `..`, and symbolic links
-- `stat` ([`Stat`](#statt))
+- `stat` ([`Stat`](#stat))
   — get information about a directory or file
 
 ### `GetSourceContext`
@@ -1411,7 +1411,7 @@ They will be added to this union automatically.
 type Protocol = ProtocolMap[keyof ProtocolMap]
 ```
 
-### `ReadFile<[T]>`
+### `ReadFile`
 
 Read the entire contents of a file (`interface`).
 
@@ -1419,7 +1419,7 @@ Read the entire contents of a file (`interface`).
 
 ```ts
 (id: ModuleId, encoding: BufferEncoding): Awaitable<string>
-(id: ModuleId, encoding?: BufferEncoding | null | undefined): T
+<T extends Awaitable<FileContent | null | undefined>>(id: ModuleId, encoding?: BufferEncoding | null | undefined): T
 ```
 
 #### Type Parameters
@@ -1439,7 +1439,7 @@ Read the entire contents of a file (`interface`).
 
 (`T`) The file contents
 
-### `Realpath<[T]>`
+### `Realpath`
 
 Compute a canonical pathname by resolving `.`, `..`, and symbolic links (`interface`).
 
@@ -1510,7 +1510,7 @@ Options for path alias resolution (`interface`).
 - `preserveSymlinks?` (`boolean` | `null` | `undefined`)
   — whether to keep symlinks instead of resolving them
 
-### `Stat<[T]>`
+### `Stat`
 
 Get information about a directory or file (`interface`).
 

package/dist/interfaces/read-file.d.mts

@@ -5,14 +5,8 @@
 import type { Awaitable, BufferEncoding, FileContent, ModuleId } from '@flex-development/mlly';
 /**
  * Read the entire contents of a file.
- *
- * @see {@linkcode Awaitable}
- * @see {@linkcode Buffer}
- *
- * @template {Awaitable<FileContent | null | undefined>} [T]
- *  The file contents
  */
-interface ReadFile<T extends Awaitable<FileContent | null | undefined> = Awaitable<FileContent>> {
+interface ReadFile {
     /**
      * @see {@linkcode ModuleId}
      *
@@ -27,8 +21,13 @@ interface ReadFile<T extends Awaitable<FileContent | null | undefined> = Awaitab
      */
     (id: ModuleId, encoding: BufferEncoding): Awaitable<string>;
     /**
+     * @see {@linkcode Awaitable}
+     * @see {@linkcode FileContent}
      * @see {@linkcode ModuleId}
      *
+     * @template {Awaitable<FileContent | null | undefined>} T
+     *  The file contents
+     *
      * @this {unknown}
      *
      * @param {ModuleId} id
@@ -38,6 +37,6 @@ interface ReadFile<T extends Awaitable<FileContent | null | undefined> = Awaitab
      * @return {T}
      *  The file contents
      */
-    (id: ModuleId, encoding?: BufferEncoding | null | undefined): T;
+    <T extends Awaitable<FileContent | null | undefined>>(id: ModuleId, encoding?: BufferEncoding | null | undefined): T;
 }
 export type { ReadFile as default };

package/dist/interfaces/realpath.d.mts

@@ -8,16 +8,15 @@ import type { Awaitable, ModuleId } from '@flex-development/mlly';
  *
  * > 👉 **Note**: A canonical pathname is not necessarily unique.
  * > Hard links and bind mounts can expose an entity through many pathnames.
- *
- * @see {@linkcode Awaitable}
- *
- * @template {Awaitable<string>} [T]
- *  The canonical pathname
  */
-interface Realpath<T extends Awaitable<string> = Awaitable<string>> {
+interface Realpath {
     /**
+     * @see {@linkcode Awaitable}
      * @see {@linkcode ModuleId}
      *
+     * @template {Awaitable<string>} T
+     *  The canonical pathname
+     *
      * @this {unknown}
      *
      * @param {ModuleId} id
@@ -25,6 +24,6 @@ interface Realpath<T extends Awaitable<string> = Awaitable<string>> {
      * @return {T}
      *  The canonical pathname
      */
-    (id: ModuleId): T;
+    <T extends Awaitable<string>>(id: ModuleId): T;
 }
 export type { Realpath as default };

package/dist/interfaces/stat.d.mts

@@ -5,16 +5,15 @@
 import type { Awaitable, ModuleId, Stats } from '@flex-development/mlly';
 /**
  * Get information about a directory or file.
- *
- * @see {@linkcode Awaitable}
- * @see {@linkcode Stats}
- *
- * @template {Awaitable<Stats>} [T]
- *  The info
  */
-interface Stat<T extends Awaitable<Stats> = Awaitable<Stats>> {
+interface Stat {
     /**
+     * @see {@linkcode Awaitable}
      * @see {@linkcode ModuleId}
+     * @see {@linkcode Stats}
+     *
+     * @template {Awaitable<Stats>} T
+     *  The info
      *
      * @this {unknown}
      *
@@ -23,6 +22,6 @@ interface Stat<T extends Awaitable<Stats> = Awaitable<Stats>> {
      * @return {T}
      *  The info
      */
-    (id: ModuleId): T;
+    <T extends Awaitable<Stats>>(id: ModuleId): T;
 }
 export type { Stat as default };

package/dist/internal/fs.browser.mjs

@@ -9,7 +9,7 @@
  */
 const fs = {
     /**
-     * Get the contents of a file.
+     * Read the entire contents of a file.
      *
      * @return {never}
      *  Never; not implemented
@@ -19,17 +19,17 @@ const fs = {
         throw new Error('[readFile] not implemented');
     },
     /**
-     * Get the resolved pathname of a file.
+     * Compute a canonical pathname by resolving `.`, `..`, and symbolic links.
      *
      * @return {never}
      *  Never; not implemented
      * @throws {Error}
      */
     realpath() {
-        throw new Error('[realpathSync] not implemented');
+        throw new Error('[realpath] not implemented');
     },
     /**
-     * Get information about a file.
+     * Get information about a directory or file.
      *
      * @return {never}
      *  Never; not implemented

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flex-development/mlly",
   "description": "ECMAScript module utilities",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "keywords": [
     "ecmascript",
     "esm",
@@ -158,7 +158,7 @@
     "@arethetypeswrong/cli": "0.18.2",
     "@commitlint/cli": "20.4.1",
     "@commitlint/types": "20.4.0",
-    "@faker-js/faker": "10.2.0",
+    "@faker-js/faker": "10.3.0",
     "@flex-development/commitlint-config": "1.0.1",
     "@flex-development/eslint-config": "1.1.1",
     "@flex-development/grease": "3.0.0-alpha.9",
@@ -180,7 +180,7 @@
     "chai-string": "1.6.0",
     "concat-stream": "2.0.0",
     "cross-env": "10.1.0",
-    "cspell": "9.6.3",
+    "cspell": "9.6.4",
     "dprint": "0.51.1",
     "editorconfig": "3.0.1",
     "eslint": "9.39.2",
@@ -188,7 +188,7 @@
     "husky": "9.1.7",
     "import-meta-resolve": "4.2.0",
     "is-ci": "4.1.0",
-    "msw": "2.12.7",
+    "msw": "2.12.9",
     "node-notifier": "10.0.1",
     "remark": "15.0.1",
     "remark-cli": "12.0.1",