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

Class PreactComponent

A Preact component.

Import path

import javascript

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getADirectPropsAccess

    Gets an access to the props object of this component.

    getADirectStateAccess

    Gets an access to the state object of this component.

    Inherited predicates

    analyze

    Gets type inference results for this element.

    from ValueNode
    describe

    Gets a description of this class or interface.

    from ClassDefinition
    flow

    Gets the data flow node associated with this program element.

    from ValueNode
    getACallSignature

    Gets a call signature declared in this interface.

    from ClassOrInterface
    getACandidatePropsSource

    Gets a value that will become (part of) the props object of this component, for example the argument to the constructor of this component.

    from ReactComponent
    getACandidatePropsValue

    Gets an expression that will become the value of the props property name of this component, for example the attribute value of a JSX element that instantiates this component.

    from ReactComponent
    getACandidateStateSource

    Gets a value that will become (part of) the state object of this component, for example an assignment to this.state.

    from SharedReactPreactClassComponent
    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
    getAComponentCreatorReference

    Gets a reference to the function that instantiates this component when invoked.

    from SharedReactPreactClassComponent
    getADecorator

    Gets a decorator applied to this class, if any.

    from ClassDefinition
    getADefaultPropsSource

    Gets the object that specifies default values for (some of) this components’ props.

    from SharedReactPreactClassComponent
    getAField

    Gets a field declared in this class or interface.

    from ClassOrInterface
    getAMember

    Gets a member declared in this class or interface.

    from ClassOrInterface
    getAMethod

    Gets a method declared in this class or interface.

    from ClassOrInterface
    getAMethodCall

    Gets a call to method name on this component.

    from ReactComponent
    getAPreviousPropsSource

    Gets a value that used to be the props object of this component, for example the prevProps parameter of the comoponentDidUpdate method of this component.

    from ReactComponent
    getAPreviousStateSource

    Gets a value that used to be the state object of this component, for example the prevState parameter of the comoponentDidUpdate method of this component.

    from ReactComponent
    getAPrimaryQlClass

    Gets the primary QL class for the Locatable.

    from ClassDefinition
    getAPropRead

    Gets a data flow node that reads a prop of this component.

    from ReactComponent
    getAPropRead

    Gets a data flow node that reads prop name of this component.

    from ReactComponent
    getAStateAccess

    Gets an expression that accesses a (transitive) property of the state object of this component.

    from ReactComponent
    getAStaticInitializerBlock

    Gets a static initializer of this class, if any.

    from ClassDefinition
    getASuperInterface

    Gets any type from the implements clause of this class.

    from ClassDefinition
    getASuperTypeDeclaration

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

    from ClassOrInterface
    getAThisNode

    Gets the this node in an instance method of this component.

    from ReactComponent
    getAToken

    Gets a token belonging to this element.

    from AstNode
    getATypeParameter

    Gets any type parameter declared on this function or type.

    from TypeParameterized
    getAbstractComponent

    Gets the abstract value that represents this component.

    from SharedReactPreactClassComponent
    getAnIndexSignature

    Gets an index signature declared in this interface.

    from ClassOrInterface
    getAnInstanceReference

    Gets a reference to an instance of this component.

    from ReactComponent
    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
    getComponentCreatorSource

    Gets the function that instantiates this component when invoked.

    from SharedReactPreactClassComponent
    getConstructor

    Gets the constructor of this class.

    from ClassDefinition
    getContainer

    Gets the function or toplevel to which this node belongs.

    from NodeInStmtContainer
    getDecorator

    Gets the ith decorator applied to this class.

    from ClassDefinition
    getEndLine

    Gets the line on which this element ends.

    from Locatable
    getField

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

    from ClassOrInterface
    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
    getIdentifier

    Gets the identifier naming the defined class, if any.

    from ClassDefinition
    getInstanceMethodfrom SharedReactPreactClassComponent
    getLastToken

    Gets the last token belonging to this element.

    from AstNode
    getLocation

    Gets this element’s location.

    from Locatable
    getMember

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

    from ClassOrInterface
    getMemberByIndex

    Gets the ith member declared in this class or interface.

    from ClassOrInterface
    getMethod

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

    from ClassOrInterface
    getMethodOverload

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

    from ClassOrInterface
    getName

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

    from ClassOrInterface
    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
    getRenderMethod

    Gets the render method of this component.

    from ReactComponent
    getStartLine

    Gets the line on which this element starts.

    from Locatable
    getStaticMethod

    Gets a static method of this component with the given name.

    from SharedReactPreactClassComponent
    getSuperClass

    Gets the expression denoting the super class of the defined class, if any.

    from ClassDefinition
    getSuperClassDefinition

    Gets the definition of the super class of this class, if it can be determined.

    from ClassDefinition
    getSuperInterface

    Gets the ith type from the implements clause of this class, starting at 0.

    from ClassDefinition
    getTopLevel

    Gets the toplevel syntactic unit to which this element belongs.

    from AstNode
    getTypeName

    Gets the canonical name of this class or interface type.

    from ClassOrInterface
    getTypeParameter

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

    from ClassDefinition
    getVariable

    Gets the variable holding this class.

    from ClassDefinition
    hasDefaultProps

    Holds if this component specifies default values for (some of) its props.

    from ReactComponent
    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
    isAbstract

    Holds if this class has the abstract modifier.

    from ClassDefinition
    isAmbient

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

    from AstNode
    ref

    Gets a reference to this component.

    from ReactComponent
    toString

    Gets a textual representation of this element.

    from Locatable