Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.43 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.43 KB

shelljs-plugin-sleep

GitHub Actions npm shelljs-plugin

A ShellJS plugin for the sleep() command.

Installation

$ npm install --save shelljs
$ npm install --save shelljs-plugin-sleep

Usage

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

var shell = require('shelljs');
require('shelljs-plugin-sleep');

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

sleep(seconds)

No available options.

Examples:

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. 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.