readdirStat

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

Installation is done using the npm install command:

$ npm install readdirstat

Quick start

After installing the module, we need to import it:

const readdirStat = require('readdirstat')

Now we can use the readdirStat function.

Examples

For example, To get information about files and subdirectories, which are inside the current directory, We will type the following command:

readdirStat('.')

And we get a similar result:

[
  {
    name: 'Internal folder for example',
    path: 'Internal folder for example',
    fullName: 'Internal folder for example',
    lastAccessTime: 2022-12-21T00:32:51.691Z,
    creationTime: 2022-12-21T00:32:51.655Z,
    lastModificationTime: 2022-12-21T00:32:51.655Z,
    isDirectory: true,
    isFile: false
  },
  {
    name: 'readdirStat',
    path: 'readdirStat.js',
    fullName: 'readdirStat.js',
    lastAccessTime: 2022-12-21T00:34:43.289Z,
    creationTime: 2022-11-27T23:39:01.652Z,
    lastModificationTime: 2022-12-21T00:34:09.430Z,
    isDirectory: false,
    isFile: true,
    size: 74,
    extension: '.js'
  },
  {
    name: 'sample file',
    path: 'sample file.txt',
    fullName: 'sample file.txt',
    lastAccessTime: 2022-12-21T00:32:51.655Z,
    creationTime: 2022-12-21T00:32:51.655Z,
    lastModificationTime: 2022-12-21T00:32:51.655Z,
    isDirectory: false,
    isFile: true,
    size: 15,
    extension: '.txt'
  }
]

Another example: To get information about files and subdirectories, that are inside the Sample folder directory, We will type the following command:

readdirStat('./Sample folder')

And we get a similar result:

[
  {
    name: 'Internal folder for example',
    path: 'Sample folder/Internal folder for example',
    fullName: 'Internal folder for example',
    lastAccessTime: 2022-11-27T22:11:41.057Z,
    creationTime: 2022-11-27T22:10:51.218Z,
    lastModificationTime: 2022-11-27T22:11:41.057Z,
    isDirectory: true,
    isFile: false
  },
  {
    name: 'sample file',
    path: 'Sample folder/sample file.txt',
    fullName: 'sample file.txt',
    lastAccessTime: 2022-11-27T22:11:41.117Z,
    creationTime: 2022-11-27T22:11:19.077Z,
    lastModificationTime: 2022-11-27T22:11:19.077Z,
    isDirectory: false,
    isFile: true,
    size: 0,
    extension: '.txt'
  }
]

How it works

The readdirStat function takes a folder path as a string argument, and returns an array of objects that represent its files and folders.

The array can return 2 types of objects:

1. An object that represents a folder

| Key | Value Type | Description | | --------------------- | ---------- | ------------------------------------------------------------------- | | name: | string | Contains the folder name. | | path: | string | Contains the file path. | | fullName: | string | Always the same value of name Key. | | lastAccessTime: | Date | The timestamp indicating the last time this file was accessed. | | creationTime: | Date | The timestamp indicating the creation time of this file. | | lastModificationTime: | Date | The timestamp indicating the last time the file status was changed. | | isDirectory: | boolean | Always returns true. | | isFile: | boolean | Always returns false. |

2. An object that represents a file with the following values

| Key | Value Type | Description | | --------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | | name: | string | Contains the filename without the file extension. | | path: | string | Contains the file path. | | lastAccessTime: | Date | The timestamp indicating the last time this file was accessed. | | creationTime: | Date | The timestamp indicating the creation time of this file. | | lastModificationTime: | Date | The timestamp indicating the last time the file status was changed. | | isDirectory: | boolean | Always returns false. | | isFile: | boolean | Always returns true. | | size: | number | The size of the file in bytes. If the underlying file system does not support getting the size of the file, this will be 0. | | fullName: | string | Contains the filename including the file extension. | | extension: | string | Returns only the file extension. |

License

MIT