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

Class FieldDeclaration

A field declaration in a class or interface, either a concrete definition or an abstract or ambient field signature.

Examples:

class Rectangle {
  height;                   // field declaration
  width;                    // field declaration
}

abstract class Counter {
 abstract value: number;    // field signature
}

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass

Gets the primary QL class for the Locatable.

getTypeAnnotation

Gets the type annotation of this field, if any, such as T in { x: T }.

hasDefiniteAssignmentAssertion

Holds if this is a TypeScript field marked as definitely assigned with the ! operator.

isOptional

Holds if this is a TypeScript field marked as optional with the ? operator.

isReadonly

Holds if this is a TypeScript field annotated with the readonly keyword.

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
getADecorator

Gets a decorator applied to this member.

from MemberDeclaration
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
getDeclaringClass

Gets the class this member belongs to, if any.

from MemberDeclaration
getDeclaringType

Gets the class or interface this member belongs to.

from MemberDeclaration
getDecorator

Gets the ith decorator applied to this member.

from MemberDeclaration
getDocumentation

Gets the JSDoc comment for this element, if any.

from Documentable
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 MemberDeclaration
getFirstToken

Gets the first token belonging to this element.

from AstNode
getInit

Gets the expression specifying the initial value of the member; for methods and constructors this is always a function, for fields it may not be defined.

from MemberDeclaration
getLastToken

Gets the last token belonging to this element.

from AstNode
getLocation

Gets this element’s location.

from AstNode
getMemberIndex

Gets the index of this member within its enclosing type.

from MemberDeclaration
getName

Gets the name of this member.

from MemberDeclaration
getNameExpr

Gets the expression specifying the name of this member, or nothing if this is a call signature.

from MemberDeclaration
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
getStaticAsBool

Gets a boolean indicating if this member is static.

from MemberDeclaration
getTopLevel

Gets the toplevel syntactic unit to which this element belongs.

from AstNode
hasImpureNameExpr

Holds if the name of this member is computed by an impure expression.

from MemberDeclaration
hasPrivateFieldName

Holds if the member has a private name, such as #foo, referring to a private field in the class.

from MemberDeclaration
hasPrivateKeyword

Holds if this is a TypeScript member annotated with the private keyword.

from MemberDeclaration
hasPublicKeyword

Holds if this is a TypeScript member explicitly annotated with the public keyword.

from MemberDeclaration
inExternsFile

Holds if this syntactic entity belongs to an externs file.

from AstNode
isAbstract

Holds if this member is abstract.

from MemberDeclaration
isAmbient

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

from AstNode
isComputed

Holds if the name of this member is computed.

from MemberDeclaration
isConcrete

True if this is neither abstract, ambient, nor part of an overloaded method signature.

from MemberDeclaration
isPrivate

Holds if this member is considered private.

from MemberDeclaration
isProtected

Holds if this is a TypeScript member annotated with the protected keyword.

from MemberDeclaration
isPublic

Holds if this member is public, either because it has no access modifier or because it is explicitly annotated as public.

from MemberDeclaration
isSignature

True if this is abstract, ambient, or an overload signature.

from MemberDeclaration
isStatic

Holds if this member is static.

from MemberDeclaration
toString

Gets a textual representation of this element.

from MemberDeclaration