@zerodep/string-words

A utility to split a sentence of words into an array of those words and remove punctuation. Non-string values will cause a ZeroDepError to be thrown.

Full documentation is available at the zerodep.app page.

Signature

declare const stringWords: (value: string, separator?: string | RegExp) => string[];

Function Parameters

The stringWords function has the following parameters:

• value - the value to modify
• separator - optional character/string at which to split, default is a space character

Examples

All @zerodep packages support both ESM and CJS formats, each complete with Typescript typings.

// ESM
import { stringWords } from '@zerodep/string-words';

// CJS
const { stringWords } = require('@zerodep/string-words');

// strings with various permutations
stringWords('California'); // ["California"]
stringWords('3.14 Pi'); // ["3.14", "Pi"]
stringWords("I'll be there for you. How about you?"); // ["I'll", "be", "there", "for", "you", "How", "about", "you"]
stringWords(''); // []

// with a custom separator
stringWords('this_is_a_snake_case_string', '_'); // ["this", "is", "a", "snake", "case", "string"]

// with anything that is not a string
stringWords({ a: 'not string' }); // throws ZeroDepError: Value is not a string

---

ZeroDep Advantages

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
• ESM & CJS - has both ecmascript modules and common javascript exports
• Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
• Fully typed - typescript definitions are provided for every package for a better developer experience
• Semantically named - package and method names are easy to grok, remember, use, and read
• Documented - actually useful documentation with examples at zerodep.app
• Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
• 100% Tested - all methods and packages are fully unit tested
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
• MIT Licensed - permissively licensed for maximum usability