tsutils
Advanced tools
Changelog
3.11.0
Features:
isNumericOrStringLikeLiteral, isTupleTypeReferenceintersectionTypeParts as counterpart to unionTypePartssomeTypePart to execute a callback for each union or intersection constituent until the callback returns truegetPropertyOfType looks up a property by its escaped nameisPropertyReadonlyInType determines whether a property in a given type cannot be written tosymbolHasReadonlyDeclaration determines if a Symbol has any readonly or constant declarationisNumericPropertyName determines whether a property name would match an index signatureisBindableObjectDefinePropertyCall returns true for statically analyzable forms of Object.defineProperty(o, 'p', {value, writable})isReadonlyAssignmentDeclaration determines whether an Object.defineProperty call is known to result in a readonly propertygetLateBoundPropertyNames returns all known property names of an expressiongetPropertyNameFromType extracts the property name of literal typesisWellKnownSymbolLiterally to recognize expressions in the form of Symbol.<name>getPropertyNameOfWellKnownSymbol returns the escaped name for a well known symbol literalunwrapParentheses returns the first child expression that is not a ParenthesizedExpressionReadme
This package consists of two major parts: utilities and typeguard functions. By importing the project you will get both of them.
import * as utils from "tsutils";
utils.isIdentifier(node); // typeguard
utils.getLineRanges(sourceFile); // utilities
If you don't need everything offered by this package, you can select what should be imported. The parts that are not imported are never read from disk and may save some startup time and reduce memory consumtion.
If you only need typeguards you can explicitly import them:
import { isIdentifier } from "tsutils/typeguard";
// You can even distiguish between typeguards for nodes and types
import { isUnionTypeNode } from "tsutils/typeguard/node";
import { isUnionType } from "tsutils/typeguard/type";
If you only need the utilities you can also explicitly import them:
import { forEachComment, forEachToken } from "tsutils/util";
This package is backwards compatible with typescript 2.8.0 at runtime although compiling might need a newer version of typescript installed.
Using typescript@next might work, but it's not officially supported. If you encounter any bugs, please open an issue.
For compatibility with older versions of TypeScript typeguard functions are separated by TypeScript version. If you are stuck on typescript@2.8, you should import directly from the submodule for that version:
// all typeguards compatible with typescript@2.8
import { isIdentifier } from "tsutils/typeguard/2.8";
// you can even use nested submodules
import { isIdentifier } from "tsutils/typeguard/2.8/node";
// all typeguards compatible with typescript@2.9 (includes those of 2.8)
import { isIdentifier } from "tsutils/typeguard/2.9";
// always points to the latest stable version (2.9 as of writing this)
import { isIdentifier } from "tsutils/typeguard";
import { isIdentifier } from "tsutils";
// always points to the typeguards for the next TypeScript version (3.0 as of writing this)
import { isIdentifier } from "tsutils/typeguard/next";
Note that if you are also using utility functions, you should prefer the relevant submodule:
// importing directly from 'tsutils' would pull in the latest typeguards
import { forEachToken } from 'tsutils/util';
import { isIdentifier } from 'tsutils/typeguard/2.8';
FAQs
utilities for working with typescript's AST
We found that tsutils demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.