tree: 19013e8f19757bc86092b8470acb811fbb7a1b7c [path history] [tgz]
  1. index.d.ts
  2. index.js
  3. license
  4. package.json
  5. readme.md
node_modules/reserved-identifiers/readme.md

reserved-identifiers

Provides a list of reserved identifiers for JavaScript

It assumes the latest JavaScript version (ES2023) and module context. Supporting older JavaScript versions is a non-goal.

Install

npm install reserved-identifiers

Usage

import reservedIdentifiers from 'reserved-identifiers';

const identifiers = reservedIdentifiers();
const isReserved = identifier => identifiers.has(identifier);

console.log(isReserved('await'));
//=> true

API

reservedIdentifiers(options?)

Returns a Set with the identifiers.

options

Type: object

includeGlobalProperties

Type: boolean
Default: false

Include the global properties globalThis, Infinity, NaN, and undefined. Although not officially reserved, they should typically not be used as identifiers.

typeScriptReservedTypes()

Returns a Set with TypeScript's built-in types that are reserved and cannot be used for type names (interfaces, type aliases, enums, classes, type parameters).

import {typeScriptReservedTypes} from 'reserved-identifiers';

const types = typeScriptReservedTypes();

console.log(types.has('any'));
//=> true

console.log(types.has('unknown'));
//=> true

Related

  • is-identifier - Check if a string is a valid JavaScript identifier