CodeQL library for JavaScript/TypeScript
codeql/javascript-all 0.8.13 (changelog, source)
Search

Class PropertyPattern

A property pattern in an object pattern.

Examples:

function f(x, { y: z }, ...rest) {  // `y: z` is a property pattern
  var [ a, b ] = rest;
  var c;
}

Import path

import javascript

Direct supertypes

Indirect supertypes

Predicates

getAPrimaryQlClass

Gets the primary QL class for the Locatable.

getDefault

Gets the default value of this property pattern, if any.

getFirstControlFlowNode

Gets the first control flow node belonging to this syntactic entity.

getName

Gets the name of the property matched by this pattern.

getNameExpr

Gets the expression specifying the name of the matched property.

getObjectPattern

Gets the object pattern this property pattern belongs to.

getValuePattern

Gets the expression the matched property value is assigned to.

isComputed

Holds if the name of this property pattern is computed.

isImpure

Holds if this pattern is impure, that is, if its evaluation could have side effects.

isShorthand

Holds if this property pattern is a shorthand pattern.

toString

Gets a textual representation of this element.

Inherited predicates

getAChild

Gets a child node of this node.

from AstNode
getAChildExpr

Gets a child expression of this node.

from AstNode
getAChildStmt

Gets a child statement of this node.

from AstNode
getAToken

Gets a token belonging to this element.

from AstNode
getChild

Gets the ith child node of this node.

from AstNode
getChildExpr

Gets the ith child expression of this node.

from AstNode
getChildStmt

Gets the ith child statement of this node.

from AstNode
getChildTypeExpr

Gets the ith child type expression of this node.

from AstNode
getContainer

Gets the function or toplevel to which this node belongs.

from NodeInStmtContainer
getEndLine

Gets the line on which this element ends.

from Locatable
getFile

Gets the file this program element comes from.

from AstNode
getFirstToken

Gets the first token belonging to this element.

from AstNode
getLastToken

Gets the last token belonging to this element.

from AstNode
getLocation

Gets this element’s location.

from Locatable
getNumChild

Gets the number of child nodes of this node.

from AstNode
getNumChildExpr

Gets the number of child expressions of this node.

from AstNode
getNumChildStmt

Gets the number of child statements of this node.

from AstNode
getNumLines

Gets the number of lines covered by this element.

from Locatable
getParent

Gets the parent node of this node, if any.

from AstNode
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Locatable
getStartLine

Gets the line on which this element starts.

from Locatable
getTopLevel

Gets the toplevel syntactic unit to which this element belongs.

from AstNode
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from AstNode
isAmbient

Holds if this is part of an ambient declaration or type annotation in a TypeScript file.

from AstNode

Charpred