Comparing version 3.20.0 to 3.21.0
@@ -0,1 +1,8 @@ | ||
# 3.21.0 | ||
**Features:** | ||
* added `getWellKnownSymbolPropertyOfType` to reliably get symbol named properties due to changes in typescript@4.3 | ||
* `getPropertyNameOfWellKnownSymbol` is now deprecated | ||
# 3.20.0 | ||
@@ -2,0 +9,0 @@ |
{ | ||
"name": "tsutils", | ||
"version": "3.20.0", | ||
"version": "3.21.0", | ||
"description": "utilities for working with typescript's AST", | ||
@@ -5,0 +5,0 @@ "scripts": { |
@@ -24,2 +24,3 @@ import * as ts from 'typescript'; | ||
export declare function getPropertyOfType(type: ts.Type, name: ts.__String): ts.Symbol | undefined; | ||
export declare function getWellKnownSymbolPropertyOfType(type: ts.Type, wellKnownSymbolName: string, checker: ts.TypeChecker): ts.Symbol | undefined; | ||
/** Determines if writing to a certain property of a given type is allowed. */ | ||
@@ -26,0 +27,0 @@ export declare function isPropertyReadonlyInType(type: ts.Type, name: ts.__String, checker: ts.TypeChecker): boolean; |
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.getBaseClassMemberOfClassElement = exports.getIteratorYieldResultFromIteratorResult = exports.getInstanceTypeOfClassLikeDeclaration = exports.getConstructorTypeOfClassLikeDeclaration = exports.getSymbolOfClassLikeDeclaration = exports.getPropertyNameFromType = exports.symbolHasReadonlyDeclaration = exports.isPropertyReadonlyInType = exports.getPropertyOfType = exports.isBooleanLiteralType = exports.isFalsyType = exports.isThenableType = exports.someTypePart = exports.intersectionTypeParts = exports.unionTypeParts = exports.getCallSignaturesOfType = exports.isTypeAssignableToString = exports.isTypeAssignableToNumber = exports.isOptionalChainingUndefinedMarkerType = exports.removeOptionalChainingUndefinedMarkerType = exports.removeOptionalityFromType = exports.isEmptyObjectType = void 0; | ||
exports.getBaseClassMemberOfClassElement = exports.getIteratorYieldResultFromIteratorResult = exports.getInstanceTypeOfClassLikeDeclaration = exports.getConstructorTypeOfClassLikeDeclaration = exports.getSymbolOfClassLikeDeclaration = exports.getPropertyNameFromType = exports.symbolHasReadonlyDeclaration = exports.isPropertyReadonlyInType = exports.getWellKnownSymbolPropertyOfType = exports.getPropertyOfType = exports.isBooleanLiteralType = exports.isFalsyType = exports.isThenableType = exports.someTypePart = exports.intersectionTypeParts = exports.unionTypeParts = exports.getCallSignaturesOfType = exports.isTypeAssignableToString = exports.isTypeAssignableToNumber = exports.isOptionalChainingUndefinedMarkerType = exports.removeOptionalChainingUndefinedMarkerType = exports.removeOptionalityFromType = exports.isEmptyObjectType = void 0; | ||
const ts = require("typescript"); | ||
@@ -176,2 +176,22 @@ const type_1 = require("../typeguard/type"); | ||
exports.getPropertyOfType = getPropertyOfType; | ||
function getWellKnownSymbolPropertyOfType(type, wellKnownSymbolName, checker) { | ||
const prefix = '__@' + wellKnownSymbolName; | ||
for (const prop of type.getProperties()) { | ||
if (!prop.name.startsWith(prefix)) | ||
continue; | ||
const globalSymbol = checker.getApparentType(checker.getTypeAtLocation(prop.valueDeclaration.name.expression)).symbol; | ||
if (prop.escapedName === getPropertyNameOfWellKnownSymbol(checker, globalSymbol, wellKnownSymbolName)) | ||
return prop; | ||
} | ||
return; | ||
} | ||
exports.getWellKnownSymbolPropertyOfType = getWellKnownSymbolPropertyOfType; | ||
function getPropertyNameOfWellKnownSymbol(checker, symbolConstructor, symbolName) { | ||
const knownSymbol = symbolConstructor && | ||
checker.getTypeOfSymbolAtLocation(symbolConstructor, symbolConstructor.valueDeclaration).getProperty(symbolName); | ||
const knownSymbolType = knownSymbol && checker.getTypeOfSymbolAtLocation(knownSymbol, knownSymbol.valueDeclaration); | ||
if (knownSymbolType && type_1.isUniqueESSymbolType(knownSymbolType)) | ||
return knownSymbolType.escapedName; | ||
return ('__@' + symbolName); | ||
} | ||
/** Determines if writing to a certain property of a given type is allowed. */ | ||
@@ -254,3 +274,5 @@ function isPropertyReadonlyInType(type, name, checker) { | ||
return { | ||
displayName: `[${type.symbol ? type.symbol.name : type.escapedName.replace(/^__@|@\d+$/g, '')}]`, | ||
displayName: `[${type.symbol | ||
? `${isKnownSymbol(type.symbol) ? 'Symbol.' : ''}${type.symbol.name}` | ||
: type.escapedName.replace(/^__@|@\d+$/g, '')}]`, | ||
symbolName: type.escapedName, | ||
@@ -260,2 +282,12 @@ }; | ||
exports.getPropertyNameFromType = getPropertyNameFromType; | ||
function isKnownSymbol(symbol) { | ||
return util_1.isSymbolFlagSet(symbol, ts.SymbolFlags.Property) && | ||
symbol.valueDeclaration !== undefined && | ||
node_1.isInterfaceDeclaration(symbol.valueDeclaration.parent) && | ||
symbol.valueDeclaration.parent.name.text === 'SymbolConstructor' && | ||
isGlobalDeclaration(symbol.valueDeclaration.parent); | ||
} | ||
function isGlobalDeclaration(node) { | ||
return util_1.isNodeFlagSet(node.parent, ts.NodeFlags.GlobalAugmentation) || node_1.isSourceFile(node.parent) && !ts.isExternalModule(node.parent); | ||
} | ||
function getSymbolOfClassLikeDeclaration(node, checker) { | ||
@@ -262,0 +294,0 @@ var _a; |
@@ -245,2 +245,3 @@ import * as ts from 'typescript'; | ||
} | ||
/** @deprecated typescript 4.3 removed the concept of literal well known symbols. Use `getPropertyNameFromType` instead. */ | ||
export declare function getPropertyNameOfWellKnownSymbol(node: WellKnownSymbolLiteral): PropertyName; | ||
@@ -247,0 +248,0 @@ export interface LateBoundPropertyNames { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
382326
4584