feat: add homeDir() API method (NodeSecure#10)

README.md

@@ -49,6 +49,13 @@ const result = (
 assert.strictEqual(result, void 0);
 ```
 
+Get os HOME configuration directory
+```
+import * as RC from "@nodesecure/rc";
+
+const K_HOME_PATH = RC.homedir();
+```
+
 > 👀 .read and .write return Rust like [Result](https://doc.rust-lang.org/std/result/) object. Under the hood we use [ts-results](https://github.com/vultix/ts-results) to achieve this.
 
 ## API
@@ -111,6 +118,16 @@ export interface writePartialPayload {
 export type writeOptions = writeCompletePayload | writePartialPayload;
 ```
 
+### homedir(): string
+
+Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
+
+```ts
+import * as RC from "@nodesecure/rc";
+
+const homedir = RC.homedir();
+```
+
 ### CONSTANTS
 
 ```ts

src/index.ts

@@ -2,4 +2,4 @@ export * from "./functions/read.js";
 export * from "./functions/write.js";
 export * as CONSTANTS from "./constants.js";
 
-export { RC, JSONSchema, homeDir } from "./rc.js";
+export { RC, JSONSchema, homedir } from "./rc.js";

src/rc.ts

@@ -66,7 +66,7 @@ export function generateDefaultRC(mode: RCGenerationMode | RCGenerationMode[] =
 /**
  * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
  */
-export function homeDir(): string {
+export function homedir(): string {
   return path.join(os.homedir(), GLOBAL_CONFIGURATION_DIRECTORY);
 }