removenonwords.js

  1. import replace from './replace'
  2. /**
  3.  * @module removeNonWords
  4.  * @description
  5.  * Remove all non word characters.
  6.  * ## Install
  7.  * Install all functions of strman
  8.  * ```sh
  9.  * yarn add strman
  10.  * ```
  11.  * or just the removeNonWords function
  12.  * ```sh
  13.  * yarn add strman.removenowords
  14.  * ```
  15.  * ## Usage
  16.  * ```javascript
  17.  * import { removeNonWords } from 'strman'
  18.  * // OR
  19.  * import removeNonWords from 'strman.removenowords'
  20.  * ```
  21.  * @param {String} value The String!
  22.  * @param {String} [replaced = ''] Value to replace.
  23.  * @example
  24.  * const title = '__strman../'
  25.  * removeNonWords(title)
  26.  * // => 'strman'
  27.  * @returns {String} String without non word characters.
  28.  */
  29. export default (value, replaced = '') => replace(value, '[^\\w]+', replaced)