craydent-fs

Node module to extend fs functionality and simplify code for maintainability and readability

Usage no npm install needed!

<script type="module">
  import craydentFs from 'https://cdn.skypack.dev/craydent-fs';
</script>

README

Craydent 0.13.4

by Clark Inada

Craydent is all inclusive utility library. There are several ways to use the library in NodeJS. More detailed documentation on constants can be found at Craydent Properties. More detailed documentation on methods can be found at Craydent Methods

// require with prototypes - this require will add prototypes to extend classes and add two constants ($c, $g) to the global space.
// $g is an alias to global and $c is the constant containing all the utility methods and properties.
require('craydent-fs');
$c.logit($c.VERSION);
arr.prototypedMethod(args);
// require no conflict - this require is the fully modular version with no global constants, prototypes, or methods.
var $c = require('craydent-fs/noConflict');
$c.logit($c.VERSION);
$c.prototypedMethod(arr, args);
// require global - this require constants and methods in the global space and add prototypes to extend classes.
// $g is an alias to global and $c is the constant containing all the utility methods and properties.
require('craydent-fs/global');
logit($c.VERSION);
arr.prototypedMethod(args);

Categories

Constants

CONSOLE_COLORS (Object) LOCAL_IP (String) TEMPLATE_TAG_CONFIG (Object)
DEBUG_MODE (Boolean) MODULES_LOADED (Object) TEMPLATE_VARS (Array)
ERROR_TYPES (Array) PUBLIC_IP (String) VERSION (String)
HTTP_STATUS_TEMPLATE (Object) RESPONSES (Object)

Methods

FS


access


Info: A promisified version of access. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


appendFile


Info: A promisified version of appendFile. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


chmod


Info: A promisified version of chmod. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


chown


Info: A promisified version of chown. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


close


Info: A promisified version of close. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


copyFile


Info: A promisified version of copyFile. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


fchmod


Info: A promisified version of fchmod. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


fchown


Info: A promisified version of fchown. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


fdatasync


Info: A promisified version of fdatasync. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


fstat


Info: A promisified version of fstat. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


fsync


Info: A promisified version of fsync. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


ftruncate


Info: A promisified version of ftruncate. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


futimes


Info: A promisified version of futimes. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


lchmod


Info: A promisified version of lchmod. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


lchown


Info: A promisified version of lchown. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


link


Info: A promisified version of link. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


lstat


Info: A promisified version of lstat. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


mkdir


Info: A promisified version of mkdir. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


mkdtemp


Info: A promisified version of mkdtemp. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


open


Info: A promisified version of open. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


read


Info: A promisified version of read. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


readFile


Info: A promisified version of readFile. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


readdir


Info: A promisified version of readdir. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


readlink


Info: A promisified version of readlink. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


realpath


Info: A promisified version of realpath. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


rename


Info: A promisified version of rename. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


rmdir


Info: A promisified version of rmdir. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


stat


Info: A promisified version of stat. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


symlink


Info: A promisified version of symlink. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


truncate


Info: A promisified version of truncate. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


unlink


Info: A promisified version of unlink. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


write


Info: A promisified version of write. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


utimes


Info: A promisified version of utimes. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None


writeFile


Info: A promisified version of writeFile. The arguments are the same as the native fs methods minus the callback.

Return: (any)

Parameters:

None

Overloads:

None

Download