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

Class ClassOrInterface

An ECMAScript 2015/TypeScript class definition or a TypeScript interface definition, including both declarations and expressions.

Examples:

class Rectangle extends Shape {
  Rectangle(width, height) {
    this.width = width;
    this.height = height;
  }

  area() { return this.width * this.height; }
}

interface EventEmitter<T> {
  addListener(listener: (x: T) => void): void;
}

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

describe

Gets a description of this class or interface.

getACallSignature

Gets a call signature declared in this interface.

getAField

Gets a field declared in this class or interface.

getAMember

Gets a member declared in this class or interface.

getAMethod

Gets a method declared in this class or interface.

getASuperInterface

Gets any type from the implements clause of this class or extends clause of this interface.

getASuperTypeDeclaration

Gets the ClassOrInterface corresponding to either a super type or an implemented interface.

getAnIndexSignature

Gets an index signature declared in this interface.

getField

Gets the field with the given name declared in this class or interface.

getIdentifier

Gets the identifier naming the declared type, if any.

getMember

Gets the member with the given name declared in this class or interface.

getMemberByIndex

Gets the ith member declared in this class or interface.

getMethod

Gets the method with the given name declared in this class or interface.

getMethodOverload

Gets an overloaded version of the method with the given name declared in this class or interface.

getName

Gets the name of the defined class or interface, possibly inferred from the context if this is an anonymous class expression.

getSuperClass

Gets the expression denoting the super class of this class, or nothing if this is an interface or a class without an extends clause.

getSuperInterface

Gets the nth type from the implements clause of this class or extends clause of this interface, starting at 0.

getTypeName

Gets the canonical name of this class or interface type.

isAbstract

Holds if this is an interface or a class declared with the abstract modifier.

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
getAPrimaryQlClass

Gets the primary QL class for the Locatable.

from Locatable
getAToken

Gets a token belonging to this element.

from AstNode
getATypeParameter

Gets any type parameter declared on this function or type.

from TypeParameterized
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
getFirstControlFlowNode

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

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 AstNode
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
getNumTypeParameter

Gets the number of type parameters declared on this function or type.

from TypeParameterized
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
getTypeParameter

Gets the nth type parameter declared on this function or type.

from TypeParameterized
hasTypeParameters

Holds if this function or type declares any type parameters.

from TypeParameterized
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
toString

Gets a textual representation of this element.

from Locatable