String to JavaScript Identifier Converter

1.0.1 · maintenance · verified Sun Apr 19

The `toidentifier` package is a minimalist utility designed to convert human-readable strings into valid JavaScript identifiers. It operates by splitting the input string into words, capitalizing the first letter of each word, joining them without separators, and finally removing any non-word characters (anything outside `[0-9a-z_]`). This results in a camelCase-like string suitable for variable names or object properties. The current stable version is 1.0.1, and given its focused and complete functionality, it maintains a very low release cadence, emphasizing stability over frequent updates. Its primary differentiation lies in its simplicity and predictable transformation rules, making it a reliable choice for basic identifier sanitization.

Common errors

```
TypeError: toIdentifier is not a function
```
cause Attempting to access the function as a property of the imported module object (e.g., `require('toidentifier').toIdentifier`) instead of as the default export.

fix When using `require`, the function is the direct export, so use `const toIdentifier = require('toidentifier')`. For TypeScript or ES modules with interop, use `import toIdentifier from 'toidentifier'`.
```
ReferenceError: require is not defined
```
cause Using `require()` syntax directly in a native ES module environment (e.g., a `.mjs` file or a project with `"type": "module"` in `package.json`) without a transpilation step.

fix For native ES module environments, use `import toIdentifier from 'toidentifier'`. If `"esModuleInterop": true` is in your `tsconfig.json` for TypeScript, this will work. Otherwise, ensure your build process correctly transpiles CommonJS modules for ESM consumption.

Warnings

gotcha The package is a pure CommonJS module. Direct ES Module imports (`import ... from 'pkg'`) will not function in environments expecting native ESM without specific Node.js configuration (like 'type: module' in package.json) or a bundler to handle CJS-to-ESM transpilation.
Fix: For CommonJS environments, use `const Name = require('pkg')`. For ES module environments, either configure your build system to handle CommonJS imports or ensure `"esModuleInterop": true` is set in your `tsconfig.json` for TypeScript projects. If using Node.js with `"type": "module"`, `import toIdentifier from 'toidentifier'` will work due to Node's CJS interoperability.
gotcha The `toIdentifier` function strictly removes all non-word characters (anything not `[0-9a-z_]`) after capitalization and joining. If you require a more permissive identifier or need to preserve certain symbols, this utility will not be suitable.
Fix: Review the transformation rules to ensure they align with your requirements. If not, consider a different utility or implement custom string sanitization logic.
gotcha This package has not been updated in several years (last publish over 4 years ago). While stable due to its simple functionality, it may not receive updates for newer JavaScript features, bug fixes, or security patches, though its minimal scope makes major vulnerabilities unlikely.
Fix: Evaluate if the package's existing functionality meets your long-term needs. For critical applications, consider vendoring the code or forking the repository if maintenance becomes a concern.

Install

npm install toidentifier npm
yarn add toidentifier yarn
pnpm add toidentifier pnpm

Imports

toIdentifier
wrong:
```
import toIdentifier from 'toidentifier'
```
correct:
```
const toIdentifier = require('toidentifier')
```
This package is a CommonJS module and exports a single function. Direct ES module import syntax (`import`) will not work without a bundler or Node.js's CJS interoperability settings (e.g., `"type": "module"` in package.json with `import toIdentifier from 'toidentifier';`).
toIdentifier (TypeScript)
wrong:
```
import { toIdentifier } from 'toidentifier'
```
correct:
```
import toIdentifier from 'toidentifier'
```
Even though it's a CommonJS module, TypeScript's default import interop (enabled with `"esModuleInterop": true` in `tsconfig.json`) allows this syntax for default CJS exports. Attempting a named import (`{ toIdentifier }`) will result in an error.

Quickstart

Demonstrates how to import and use the `toIdentifier` function to convert various strings into valid JavaScript identifiers, highlighting its sanitization behavior.

const toIdentifier = require('toidentifier');

console.log(toIdentifier('Bad Request'));
// Expected output: "BadRequest"

console.log(toIdentifier('user-name-id'));
// Expected output: "UserNameId"

console.log(toIdentifier('item name #1!'));
// Expected output: "ItemName1"

console.log(toIdentifier('another string with spaces and symbols @#$%^&*()'));
// Expected output: "AnotherStringWithSpacesAndSymbols"

view raw JSON →