refactor(read.ts): Add a memoize option

README.md

@@ -99,6 +99,12 @@ interface createReadOptions {
    * @default `minimal`
    */
   createMode?: RCGenerationMode | RCGenerationMode[];
+  /**
+   * RC automatic caching option. This option allows to cache a configuration passed in parameter.
+   *
+   * @default false
+   */
+  memoize?: boolean;
 }
 
 export type readOptions = RequireAtLeastOne<

src/functions/read.ts

@@ -10,6 +10,7 @@ import { RequireAtLeastOne } from "type-fest";
 // Import Internal Dependencies
 import { RC, JSONSchema, generateDefaultRC, RCGenerationMode } from "../rc.js";
 import * as CONSTANTS from "../constants.js";
+import { memoize } from "./memoize.js";
 
 // CONSTANTS
 const { Ok, Err } = TR;
@@ -27,6 +28,13 @@ interface createReadOptions {
    * @default `minimal`
    */
   createMode?: RCGenerationMode | RCGenerationMode[];
+
+  /**
+   * RC automatic caching option. This option allows to cache a configuration passed in parameter.
+   *
+   * @default false
+   */
+  memoize?: boolean;
 }
 
 export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
@@ -36,7 +44,7 @@ export async function read(
   options: readOptions = Object.create(null)
 ): Promise<Result<RC, NodeJS.ErrnoException>> {
   try {
-    const { createIfDoesNotExist = Boolean(options.createMode), createMode } = options;
+    const { createIfDoesNotExist = Boolean(options.createMode), createMode, memoize: memoizeRc = false } = options;
 
     const cfgPath = path.join(location, CONSTANTS.CONFIGURATION_NAME);
     const cfg = new Config<RC>(cfgPath, {
@@ -50,6 +58,10 @@ export async function read(
     }
     const result = cfg.payload;
 
+    if (memoizeRc) {
+      memoize(result);
+    }
+
     await cfg.close();
 
     return new Ok(result);

test/read.spec.ts

@@ -8,7 +8,7 @@ import { fileURLToPath } from "node:url";
 import { expect } from "chai";
 
 // Import Internal Dependencies
-import { read, CONSTANTS } from "../src/index.js";
+import { read, CONSTANTS, memoized, memoize, clearMemoized } from "../src/index.js";
 import { generateDefaultRC } from "../src/rc.js";
 
 // CONSTANTS
@@ -66,3 +66,38 @@ describe("read .nodesecurerc", () => {
     });
   });
 });
+
+describe("read | memoize option", () => {
+  const location = path.join(os.tmpdir(), "rcread");
+
+  before(async() => {
+    await fs.mkdir(location);
+  });
+
+  beforeEach(async() => {
+    clearMemoized();
+    await fs.rm(path.join(location, CONSTANTS.CONFIGURATION_NAME), { force: true });
+  });
+
+  after(async() => {
+    await fs.rm(location, { force: true, recursive: true });
+  });
+
+  it("should return the default value 'null' when the memoize option is not declared ", async() => {
+    await read(location, { createIfDoesNotExist: true });
+    expect(memoized()).to.eq(null);
+  });
+
+  it("should return the configuration passed in parameter", async() => {
+    await read(location, { createIfDoesNotExist: true, memoize: true });
+    expect(memoized()).to.deep.equal(generateDefaultRC());
+  });
+
+  it("must overwrite the previously stored payload", async() => {
+    await read(location, { createIfDoesNotExist: true, memoize: true });
+
+    memoize(generateDefaultRC("report"));
+
+    expect(memoized()).to.deep.equal(generateDefaultRC("report"));
+  });
+});