@zerodep/string

A set of string manipulation functions.

This is a barrel package of all @zerodep/string.* utility packages within the @zerodep monorepo.

tl;dr

A short explanation / quick reference:

import { stringLowerFirst, stringUpperFirst, stringWords } from '@zerodep/string';

stringLowerFirst('STRING'); // "sTRING"
stringUpperFirst('string'); // "String"
stringWords('Some Words'); // ["Some", "Words"]

Table of Contents

• Installation Instructions
• Included Packages
• strings & Defensive Programming
• ZeroDep Advantages
• Support
• Semver
• Resources
• License

Install

npm install @zerodep/string

Of course, you may use yarn, pnpm, or the package manager of your choice. Only npm examples are shown for brevity.

This package may also be found on both jsDelivr and unpkg in UMD, ESM and CJS formats.

Included Packages

This barrel package includes all @zerodep/string.* packages:

Method Name	Package	Purpose	Package Size
stringDeburr	string.deburr	Utility to convert accented to non-accented characters
stringLowerFirst	string.lowerfirst	Utility to convert the first character of a string to lowercase
stringUpperFirst	string.upperfirst	Utility to convert the first character of a string to uppercase
stringTitleCase	string.titlecase	Utility to capitalize the first letter of each word in a string
stringWords	string.words	Utility to convert a string to an array of words

Advantages of @zerodep Packages

We help make source code more readable, more secure, faster to craft, less likely to have hidden defects, and easier to maintain.

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder 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 and helpful tips
• 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
• ESM & CJS - has both ecmascript modules and common javascript exports, both are fully tree-shakable
• CDN Available - available on fast content delivery networks in UMD, CJS and ESM formats
• FP Inspired - gently opinionated to encourage functional programming style for cleaner and more maintainable software
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
• MIT Licensed - permissively licensed for maximum usability

Support

All @zerodep packages are built for the ES2020 specification. Should you need to support older environments you will need to add appropriate polyfills. All packages are tested on the following platforms/browsers:

Browsers

• Chrome - last 2 major versions
• Firefox - last 2 major versions
• Safari - last 2 major versions
• Edge - last 2 major versions
• Android - last 2 major versions
• iOS - last 2 major versions

Node

• v16.x - Gallium LTS
• v14.x - Fermium LTS

It is likely the package will work on other technologies and version, however development and testing effort is only spent on the above.

Semver

All @zerodep packages, including this one, adhere to Semantic Versioning practices:

• major versions: correlates with breaking changes to one or more method signatures
• minor versions: includes addition of new functionality or backwards-compatible software improvements
• patch versions: are reserved for copy changes, documentation enhancements and bug fixes

The above said, a security best practice is to pin your software packages to specific versions and only upgrade to more recent releases after careful inspection of any CHANGELOG, release notes and all software changes.

Resources

• Security Policy
• Changelog
• Contributing Guide
• Code of Conduct

License

MIT