textconvert/dist/text/clear.js

Public library to convert text into many conventions and formats.

import { regex } from '../assets/regex';
const { values } = regex;
/**
 * Clear punctuations from a string and replaces it with a whitespace character or returns an array of strings.
 *
 * @param text String input to clear from punctuation.
 * @returns Either a string or an array of strings cleared from punctuations based on the arguments passed.
 * @example
 * clear('Hello, world!'); // 'hello world'
 */
export function clear(text) {
    // Make sure there's an input
    if (!text)
        return 'Please provide a valid input text';
    // Create an array of words
    const wordsArray = text.split(values.punctuation);
    // Filter wordsArray and remove punctuations
    const clearWords = wordsArray.map((word) => {
        word = word.trim().toLowerCase().replace(values.punctuation, '');
        return word;
    });
    return clearWords.join(' ');
}