https://github.com/nfischer/shelljs-plugin-sleep

:zzz: A ShellJS plugin for the sleep command
https://github.com/nfischer/shelljs-plugin-sleep

shelljs shelljs-plugin

Last synced: 6 months ago
JSON representation

:zzz: A ShellJS plugin for the sleep command

• Host: GitHub
• URL: https://github.com/nfischer/shelljs-plugin-sleep
• Owner: nfischer
• License: mit
• Created: 2016-08-28T02:45:13.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2025-03-09T00:20:23.000Z (11 months ago)
• Last Synced: 2025-03-25T03:51:09.515Z (11 months ago)
• Topics: shelljs, shelljs-plugin
• Language: JavaScript
• Homepage:
• Size: 42 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          
# shelljs-plugin-sleep

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/nfischer/shelljs-plugin-sleep/main.yml?style=flat-square&logo=github)](https://github.com/nfischer/shelljs-plugin-sleep/actions/workflows/main.yml)

[![npm](https://img.shields.io/npm/v/shelljs-plugin-sleep.svg?style=flat-square)](https://www.npmjs.com/package/shelljs-plugin-sleep)

[![shelljs-plugin](https://img.shields.io/badge/shelljs-plugin-brightgreen.svg?style=flat-square)](https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins)

A [ShellJS](https://github.com/shelljs/shelljs) plugin for the `sleep()`

command.

## Installation

```bash

$ npm install --save shelljs

$ npm install --save shelljs-plugin-sleep

```

## Usage

To use this plugin in your project, include it like so:

```javascript

var shell = require('shelljs');

require('shelljs-plugin-sleep');

// Ex. usage:

shell.sleep(1); // the plugin is now available!

```

### sleep(seconds)

No available options.

Examples:

```javascript

shell.sleep(3); // sleep for 3000 milliseconds

```

## Supported systems

 - Linux (all variants)

 - OS X

 - Windows

This is only supported for Node v4+

## Writing plugins

If you're interested in taking a look at the current state of the plugin API,

take a look at [index.js](index.js). This has helpful comments explaining the

necessary boilerplate for writing a plugin. For an example usage of the plugin,

take a look at [test/test.js](test/test.js).