@types/shelljs

What is @types/shelljs?

@types/shelljs provides TypeScript type definitions for the shelljs library, which is a portable (Windows/Linux/OS X) implementation of Unix shell commands on Node.js. It allows you to perform shell operations such as file manipulation, directory navigation, and command execution within a Node.js environment.

What are @types/shelljs's main functionalities?

File Manipulation

This feature allows you to perform various file operations such as copying, removing, and moving files.

const shell = require('shelljs');

// Copy a file
shell.cp('source.txt', 'destination.txt');

// Remove a file
shell.rm('file.txt');

// Move a file
shell.mv('old.txt', 'new.txt');

Directory Navigation

This feature allows you to navigate directories and list files within a directory.

const shell = require('shelljs');

// Change directory
shell.cd('/path/to/directory');

// List files in a directory
shell.ls();

Command Execution

This feature allows you to execute shell commands and handle their output and exit codes.

const shell = require('shelljs');

// Execute a command
if (shell.exec('echo "Hello, World!"').code !== 0) {
  shell.echo('Error: Command failed');
  shell.exit(1);
}

Other packages similar to @types/shelljs

child_process

The child_process module in Node.js provides the ability to spawn child processes, which can be used to execute shell commands. Unlike shelljs, it does not provide a high-level API for file and directory manipulation, but it offers more control over the execution of commands.

fs-extra

fs-extra is a module that extends the built-in fs module with additional file system methods. It provides methods for file and directory manipulation similar to shelljs but does not include command execution capabilities.

execa

execa is a modern alternative to child_process. It provides a simpler API for executing shell commands and handling their output. It does not include file and directory manipulation features like shelljs.

README

Installation

npm install --save @types/shelljs

Summary

This package contains type definitions for shelljs (http://shelljs.org).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shelljs.

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: @types/glob, @types/node

Credits

These definitions were written by Niklas Mollenhauer, Vojtech Jasny, George Kalpakas, Paul Huynh, Alexander Futász, ExE Boss, and Mirco Sanguineti.