Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lasalefamine/readdir-life

:file_folder: Check the oldest/latest files/folders within a directory
https://github.com/lasalefamine/readdir-life

directories-scanner fs life readdir sort stats

Last synced: about 1 month ago
JSON representation

:file_folder: Check the oldest/latest files/folders within a directory

Host: GitHub
URL: https://github.com/lasalefamine/readdir-life
Owner: LasaleFamine
License: mit
Created: 2017-03-05T11:46:11.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2017-03-05T14:21:04.000Z (almost 8 years ago)
Last Synced: 2024-04-26T16:04:23.214Z (8 months ago)
Topics: directories-scanner, fs, life, readdir, sort, stats
Language: JavaScript
Homepage:
Size: 129 KB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # readdir-life

[![GitHub release](https://img.shields.io/github/release/LasaleFamine/readdir-life.svg?style=flat-square)](https://github.com/LasaleFamine/readdir-life)

[![Build Status](https://travis-ci.org/LasaleFamine/readdir-life.svg?branch=master&style=flat-square)](https://travis-ci.org/LasaleFamine/readdir-life)

[![Coverage Status](https://coveralls.io/repos/github/LasaleFamine/readdir-life/badge.svg?branch=master)](https://coveralls.io/github/LasaleFamine/readdir-life?branch=master)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square)](https://github.com/LasaleFamine/readdir-life)

[![npm](https://img.shields.io/npm/dt/readdir-life.svg?style=flat-square)](https://github.com/LasaleFamine/readdir-life)

> Check the oldest/latest files/folders within a directory

## Install

```

$ yarn add readdir-life

```

## Usage

```js

const {join} = require('path');

const readdirLife = require('readdir-life');

const pathResolved = join(__dirname, 'your-path');

readdirLife.latest(pathResolved)

	.then(res => console.log(res))

	.catch(err => console.error(err));

/* =>

{

	file: 'latest-file-or-folder-modified',

	stat: {

		dev: 16777220,

		mode: 33188,

		nlink: 1,

		uid: 501,

		gid: 20,

		rdev: 0,

		blksize: 4096,

		ino: 14889287,

		size: 0,

		blocks: 0,

		atime: 2017-03-05T01:29:07.000Z,

		mtime: 2017-03-05T01:29:16.000Z,

		ctime: 2017-03-05T01:29:16.000Z,

		birthtime: 2017-03-05T01:29:06.000Z

	}

}

*/

readdirLife.sortLatest(pathResolved)

	.then(res => console.log(res))

	.catch(err => console.error(err));

/* =>

[{

	file: 'latest-file-or-folder-modified',

	stat: {

		dev: 16777220,

		mode: 33188,

		nlink: 1,

		uid: 501,

		gid: 20,

		rdev: 0,

		blksize: 4096,

		ino: 14889287,

		size: 0,

		blocks: 0,

		atime: 2017-03-05T01:29:07.000Z,

		mtime: 2017-03-05T01:29:16.000Z,

		ctime: 2017-03-05T01:29:16.000Z,

		birthtime: 2017-03-05T01:29:06.000Z

	}

}, {...}]

*/

```

## API

### .latest(input, [options])

#### input

Type: `string`

Directory to read.

#### options

##### typeTime

Type: `string`


Default: `mtime` // Modified time

Type of the time to check: `ctime|mtime|atime|birthtime`

More info: [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)

### .oldest(input, [options])

#### return

Type: `object`

#### input

Type: `string`

Directory to read.

#### options

##### typeTime

Type: `string`


Default: `mtime` // Modified time

Type of the time to check: `ctime|mtime|atime|birthtime`

More info: [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)

### .sortLatest(input, [options])

> From the latest to the oldest

#### return

Type: `array`

#### input

Type: `string`

Directory to read.

#### options

##### typeTime

Type: `string`


Default: `mtime` // Modified time

Type of the time to check: `ctime|mtime|atime|birthtime`

More info: [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)

### .sortOldest(input, [options])

> From the oldest to the latest

#### return

Type: `array`

#### input

Type: `string`

Directory to read.

#### options

##### typeTime

Type: `string`


Default: `mtime` // Modified time

Type of the time to check: `ctime|mtime|atime|birthtime`

More info: [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)

## Related

- [fs.readdir](https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback)

- [fs.Stats](https://nodejs.org/api/fs.html#fs_class_fs_stats)

## License

MIT © [LasaleFamine](https://godev.space)