@zerodep/string-trim
v2.0.12
Published
A utility to trim whitespace or specific values from the start and end of a string
Downloads
11
Readme
@zerodep/string-trim
A utility to remove a specific character from the start and end of a string. Non-string values will cause a ZeroDepError
to be thrown.
Full documentation is available at the zerodep.app page.
Signature
declare const stringTrim: (value: string, char?: string) => string;
Function Parameters
The stringTrim
function has the following parameters:
- value - the value to trim
- char - optional character/string to remove, default is a space character
Examples
All @zerodep packages support both ESM and CJS formats, each complete with Typescript typings.
// ESM
import { stringTrim } from '@zerodep/string-trim';
// CJS
const { stringTrim } = require('@zerodep/string-trim');
// with the default separator (a space character)
stringTrim(' some string '); // "some string"
// with a custom separator
stringTrim('xx some string xx', 'x'); // " some string "
// with anything that is not a string
stringTrim({ 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