time-to-botec/squiggle/node_modules/@stdlib/string/remove-punctuation/README.md

Remove Punctuation

Remove punctuation characters from a string.

Usage

var removePunctuation = require( '@stdlib/string/remove-punctuation' );

removePunctuation( str )

Removes punctuation characters from a string.

var str = removePunctuation( 'Sun Tzu said: "A leader leads by example not by force."' );
// returns 'Sun Tzu said A leader leads by example not by force'

The function removes the following characters:

description	value
Apostrophe	`
Braces	{ }
Brackets	[ ]
Colon	:
Comma	,
Exclamation Mark	!
Fraction Slash	/
Guillemets	< >
Parentheses	( )
Period	.
Semicolon	;
Tilde	~
Vertical Bar	`	`
Question Mark	?
Quotation Marks	' "

Examples

var removePunctuation = require( '@stdlib/string/remove-punctuation' );

var str;
var out;

str = 'Double, double, toil and trouble; Fire burn, and cauldron bubble!';
out = removePunctuation( str );
// returns 'Double double toil and trouble Fire burn and cauldron bubble'

str = 'This module removes these characters: `{}[]:,!/<>().;~|?\'"';
out = removePunctuation( str );
// returns 'This module removes these characters '

str = 'We have to hold the border – at all cost';
out = removePunctuation( str );
// returns 'We have to hold the border  at all cost'

str = 'This a sentence without punctuation';
out = removePunctuation( str );
// returns 'This a sentence without punctuation'

---

CLI

Usage

Usage: remove-punctuation [options] [<string>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ remove-punctuation 'beep! beep!!!'
beep beep

To use as a standard stream,

$ echo -n 'beep! beep!!!' | remove-punctuation
beep beep