https://github.com/isaacs/node-touch

touch(1) for node
https://github.com/isaacs/node-touch

Last synced: 4 days ago
JSON representation

touch(1) for node

• Host: GitHub
• URL: https://github.com/isaacs/node-touch
• Owner: isaacs
• License: isc
• Created: 2011-10-05T22:11:31.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T07:39:33.000Z (5 months ago)
• Last Synced: 2024-10-19T19:56:36.911Z (15 days ago)
• Language: JavaScript
• Homepage:
• Size: 104 KB
• Stars: 122
• Watchers: 4
• Forks: 15
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-touch

For all your node touching needs.

## Installing

```bash

npm install touch

```

## CLI Usage:

See `man touch`

This package exports a binary called `nodetouch` that works mostly

like the unix builtin `touch(1)`.

## API Usage:

```javascript

var touch = require("touch")

```

Gives you the following functions:

* `touch(filename, options, cb)`

* `touch.sync(filename, options)`

* `touch.ftouch(fd, options, cb)`

* `touch.ftouchSync(fd, options)`

All the `options` objects are optional.

All the async functions return a Promise.  If a callback function is

provided, then it's attached to the Promise.

## Options

* `force` like `touch -f` Boolean

* `time` like `touch -t ` Can be a Date object, or any parseable

  Date string, or epoch ms number.

* `atime` like `touch -a` Can be either a Boolean, or a Date.

* `mtime` like `touch -m` Can be either a Boolean, or a Date.

* `ref` like `touch -r ` Must be path to a file.

* `nocreate` like `touch -c` Boolean

If neither `atime` nor `mtime` are set, then both values are set.  If

one of them is set, then the other is not.

## cli

This package creates a `nodetouch` command line executable that works

very much like the unix builtin `touch(1)`