unified

Project: syntax-tree/estree-util-is-identifier-name

Package: estree-util-is-identifier-name@2.0.1

  1. Dependents: 0
  2. Check if something can be an ecmascript (javascript) identifier name
  1. tree 44
  2. ast 37
  3. javascript 25
  4. ecmascript 10
  5. estree 9
  6. character 5
  7. identifier 2

estree-util-is-identifier-name

Build Coverage Downloads Size Sponsors Backers Chat

estree utility to check if something can be an identifier.

Contents

What is this?

This package is a utility that can be used to check if something can be an identifier name. For example, a, _, and a1 are fine, but 1 and - are not.

When should I use this?

You can use this utility when generating IDs from strings or parsing IDs.

Install

This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

npm install estree-util-is-identifier-name

In Deno with esm.sh:

import * as isIdentifierName from 'https://esm.sh/estree-util-is-identifier-name@2'

In browsers with esm.sh:

<script type="module">
  import * as isIdentifierName from 'https://esm.sh/estree-util-is-identifier-name@2?bundle'
</script>

Use

import {cont, name, start} from 'estree-util-is-identifier-name'

name('$something69') // => true
name('69') // => false
name('var') // => true (this does not handle keywords)

start(48) // => false (character code for `0`)
cont(48) // => true (character code for `0`)

API

This package exports the identifiers cont, name, and start. There is no default export.

cont(code)

Checks if the given character code can continue an identifier.

Parameters
Returns

Whether code can continue an identifier (boolean).

name(name)

Checks if the given value is a valid identifier name.

Parameters
Returns

Whether name can be an identifier (boolean).

start(code)

Checks if the given character code can start an identifier.

Parameters
Returns

Whether code can start an identifier (boolean).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer