Dir

The dir object consists of:

mkS

Creates directory on filesystem synchronous.

Parameters:

• path {string} path to directory.

Call signature:

mkS: (path: string) => void;

Examples:

Using imported Dir object.

import { Dir } from "mylas";

Dir.mkS("./exampleDir/");

Using imported default mylas object.

import mylas from "mylas";

mylas.dir.mkS("./exampleDir/");

---

rmS

Removes directory on filesystem synchronous.

Parameters:

• path {string} path to directory.

Call signature:

rmS: (path: string) => void;

Examples:

Using imported Dir object.

import { Dir } from "mylas";

Dir.rmS("./exampleDir/");

Using imported default mylas object.

import mylas from "mylas";

mylas.dir.rmS("./exampleDir/");

---

checkS

Checks if directory exists on filesystem synchronous.

Parameters:

• path {string} path to directory.

Call signature:

checkS: (path: string) => boolean;

Examples:

Using imported Dir object.

import { Dir } from "mylas";

const result = Dir.checkS("./exampleDir/");

console.log(result)

Using imported default mylas object.

import mylas from "mylas";

const result = mylas.dir.checkS("./exampleDir/");

console.log(result)

---

mk

Creates directory on filesystem asynchronous.

Parameters:

• path {string} path to directory.
• callback {voidCallback} callback to call.

Call signature:

mk: (path: string, callback?: voidCallback | undefined) => Promise<void>;

Examples:

Using imported Dir object.
Using Await.

import { Dir } from "mylas";

await Dir.mk("./exampleDir/");

Using imported default mylas object.
Using callback.

import mylas from "mylas";

mylas.dir.mk("./exampleDir/", () => {
    console.log("Created dir");
});

---

rm

Removes directory on filesystem asynchronous.

Parameters:

• path {string} path to directory.
• callback {voidCallback} callback to call.

Call signature:

rm: (path: string, callback?: voidCallback | undefined) => Promise<void>;

Examples:

Using imported Dir object.
Using Await.

import { Dir } from "mylas";

await Dir.rm("./exampleDir/");

Using imported default mylas object.
Using callback.

import mylas from "mylas";

mylas.dir.rm("./exampleDir/", () => {
    console.log("Removed dir");
});

---

check

Checks if directory exists on filesystem asynchronous.

Parameters:

• path {string} path path to dir.
• callback {booleanCallback} callback to call.

Call signature:

check: (path: string, callback?: booleanCallback | undefined) => Promise<boolean>;

Examples:

Using imported Dir object.
Using Await.

import { Dir } from "mylas";

const result = await Dir.check("./exampleDir/");

console.log(result)

Using imported default mylas object.
Using callback.

import mylas from "mylas";

mylas.dir.check("./exampleDir/", result => {
    console.log(result);
});

nodeModules

finds where the node_modules directories are.

Parameters:

• input optional {{ cwd?: string; relative?: boolean; } | string} input optional cwd input.

Call signature:

nodeModules: (input?: { cwd?: string; relative?: boolean; } | string) => string[];

Examples:

Using imported Dir object.

import { Dir } from "mylas";

const result = Dir.nodeModules();

console.log(result); // => ["../node_modules", "node_modules"]

Using imported default mylas object.

import mylas from "mylas";

const result = mylas.dir.nodeModules();

console.log(result); // => ["../node_modules", "node_modules"]