split.js

  1. /**
  2.  * @module split
  3.  * @description
  4.  * Alias to split function.
  5.  * ## Install
  6.  * Install all functions of strman
  7.  * ```sh
  8.  * yarn add strman
  9.  * ```
  10.  * or just the split function
  11.  * ```sh
  12.  * yarn add strman.split
  13.  * ```
  14.  * ## Usage
  15.  * ```javascript
  16.  * import { split } from 'strman'
  17.  * // OR
  18.  * import split from 'strman.split'
  19.  * ```
  20.  * @param {String} value - The String!
  21.  * @param {String} separator - Split separator.
  22.  * @param {Number} limit - Split limit.
  23.  * @example
  24.  * split('strman', '')
  25.  * // => ['s', 't', 'r', 'm', 'a', 'n']
  26.  * @returns {String}  The String splited!
  27.  */
  28. export default (value, separator, limit = undefined) => value.split(separator, limit)