Logo for jsDocs.io

shellwords

  • Version 1.0.1
  • Published
  • 16.4 kB
  • No dependencies
  • MIT license

Install

npm i shellwords
yarn add shellwords
pnpm add shellwords

Overview

Manipulate strings according to the word parsing rules of the UNIX Bourne shell.

Index

Functions

Functions

function escape

escape: (str?: string) => string;

  • Escapes a string so that it can be safely used in a Bourne shell command line.

    Parameter str

    A string to escape.

    Returns

    The escaped string.

function split

split: (line?: string) => string[];

  • Splits a string into an array of tokens in the same way the UNIX Bourne shell does.

    Parameter line

    A string to split.

    Returns

    An array of the split tokens.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (9)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/shellwords.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/shellwords)
  • HTML
    <a href="https://www.jsdocs.io/package/shellwords"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>