@zerodep/case.snake v1.0.1
@zerodep/case.snake
A utility to convert a string to snake_case and strips out non-alphanumeric characters
This utility is designed for converting strings to variable names suitable for database keys and similar use-cases. It will:
- strip any leading characters that aren't letters (A to Z upper- or lowercase)
- replace non-alphanumeric characters with underscores
- format to lowercase with a single underscore separator between words
tl;dr
A short explanation / quick reference:
import { caseSnake } from '@zerodep/case.snake';
// using the default formatter (intelligently guesses your locale & currency)
caseSnake('I was a sentence'); // "i_was_a_sentence"
caseSnake('from-kebab-case'); // "from_kebab_case"
caseSnake('1234 special !@#$ chars'); // "special_chars"
Table of Contents
Install
This utility is available from multiple @zerodep packages, enabling developers to select the most appropriately sized package (for both kb and capability) for different use cases. We believe one size does not fit all or most. See @zerodep/app and @zerodep/case.
// all @zerodep features, capabilities and utilities
npm install @zerodep/app
// all @zerodep "case" utilities
npm install @zerodep/case
// only the case.snake package
npm install @zerodep/case.snake
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.
How to Use
This package exports the following:
- Functions
caseSnake
- formats a string to snake_case
- Error types
ZeroDepError
- thrown if the value to format is not a string, is an instance of the baseError
object
Signature
Typescript declarations:
declare const caseSnake: (value: string) => string;
Examples
All examples assume ESM or CJS packages. If using a UMD package remember to prefix with the zd namespace, e.g. zd.caseSnake(...)
.
import { caseSnake } from '@zerodep/case.snake';
// strings
caseSnake('UPPER CASE'); // "upper_case"
caseSnake('sentence case'); // "sentence_case"
caseSnake('kebab-case'); // "kebab_case"
caseSnake('camelCase'); // "camel_case"
caseSnake('PascalCase'); // "pascal_case"
caseSnake('__with_____many spaces and underscores__'); // "with_many_spaces_and_underscores"
caseSnake("I'm a sp3c!al $741ng"); // "i_m_a_sp3_c_al_741_ng"
caseSnake('1234 leading numbers'); // "leading_numbers"
// integers
caseSnake(42); // throws ZeroDepError
caseSnake(3e8); // throws ZeroDepError
// floats
caseSnake(-273.15); // throws ZeroDepError
caseSnake(Math.PI); // throws ZeroDepError
// number-ish
caseSnake(Number.POSITIVE_INFINITY); // throws ZeroDepError
caseSnake(NaN); // throws ZeroDepError
// bigints
caseSnake(8675309n); // throws ZeroDepError
// object literals
caseSnake({}); // throws ZeroDepError
caseSnake({ a: 'one', b: 'two' }); // throws ZeroDepError
// arrays
caseSnake([]); // throws ZeroDepError
caseSnake([1, 2, 3]); // throws ZeroDepError
caseSnake(['a', 'b', 'c']); // throws ZeroDepError
// booleans
caseSnake(true); // throws ZeroDepError
caseSnake(false); // throws ZeroDepError
// other
caseSnake(/^$\d{7}/g); // throws ZeroDepError
caseSnake(new Date()); // throws ZeroDepError
caseSnake(new Date('2022-02-24')); // throws ZeroDepError
caseSnake(new Set()); // throws ZeroDepError
caseSnake(new Set([1, 2, 3])); // throws ZeroDepError
caseSnake(new Map()); // throws ZeroDepError
caseSnake(new Map([['a', 1]])); // throws ZeroDepError
caseSnake(new Symbol()); // throws ZeroDepError
caseSnake(new Error()); // throws ZeroDepError
caseSnake(() => {}); // throws ZeroDepError
// nothing
caseSnake(null); // throws ZeroDepError
caseSnake(undefined); // throws ZeroDepError
Related Packages
The following @zerodep packages may be helpful or more appropriate for your specific case:
- @zerodep/string.titleCase - converts a string to Title Case
- @zerodep/string.sentenceCase - converts a string to Sentence case
- @zerodep/case.camel - converts a string to camelCase and strips out non-alphanumeric characters
- @zerodep/case.kebab - converts a string to kebab-case and strips out non-alphanumeric characters
- @zerodep/case.pascal - converts a string to PascalCase and strips out non-alphanumeric characters
- @zerodep/case.sentence - converts a string to sentence case and strips out non-alphanumeric characters
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.