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

Class TSConfig

A TypeScript configuration file, usually named tsconfig.json.

Import path

import semmle.javascript.TSConfig

Direct supertypes

Indirect supertypes

Known direct subtypes

    Predicates

    getAnIncludePath

    Gets a path mentioned in the include property.

    getAnIncludePathTarget

    Gets a file or folder refenced by a path the include property, possibly inherited from an extended tsconfig file.

    getAnIncludedContainer

    Gets a file or folder inside the directory tree mentioned in the include property.

    getBaseUrlFolder

    Gets the effective baseUrl folder for this tsconfig file.

    getBaseUrlFolderOrOwnFolder

    Gets the effective baseUrl folder for this tsconfig file, or its enclosing folder if there is no baseUrl.

    getBaseUrlPath

    Gets the string value in the baseUrl property.

    getCompilerOptions

    Gets the compilerOptions object.

    getEffectiveRootDir

    Gets the folder referred to by the rootDir property, or if absent, an effective root dir derived from include paths.

    getExtendedFile

    Gets the file referred to by the extends property.

    getExtendedTSConfig

    Gets the TSConfig file referred to by the extends property.

    getExtendsPath

    Gets the string value in the extends property.

    getFolder

    Gets the folder containing this file.

    getOwnBaseUrlFolder

    Gets the folder referred to by the baseUrl property in this file, not taking extends into account.

    getRootDir

    Gets the file or folder referenced by the rootDir property.

    getRootDirPath

    Gets the path mentioned in the rootDir property.

    hasExactPathMapping

    Holds if this has an exact path mapping (i.e. no wildcards) from pattern to newPath.

    hasPathMapping

    Holds if this has a path mapping from pattern to newPath.

    hasPrefixPathMapping

    Holds if this has a path mapping from the pattern prefix to the newPath prefix. The trailing * is not included.

    Inherited predicates

    getAPrimaryQlClass

    Gets the primary QL class for the Locatable.

    from JsonObject
    getBooleanValue

    If this is a boolean constant, gets its boolean value.

    from JsonValue
    getChild

    Gets the ith child value of this value.

    from JsonValue
    getElementValue

    If this is an array, gets the value of the ith element.

    from JsonValue
    getEndLine

    Gets the line on which this element ends.

    from Locatable
    getFile

    Gets the file this program element comes from.

    from Locatable
    getIntValue

    If this is an integer constant, gets its numeric value.

    from JsonValue
    getJsonFile

    Gets the JSON file containing this value.

    from JsonValue
    getLocation

    Gets this element’s location.

    from Locatable
    getNumLines

    Gets the number of lines covered by this element.

    from Locatable
    getParent

    Gets the parent value to which this value belongs, if any.

    from JsonValue
    getPrimaryQlClasses

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

    from Locatable
    getPropStringValue

    Gets the string value of property name of this object.

    from JsonObject
    getPropValue

    If this is an object, gets the value of property name.

    from JsonValue
    getStartLine

    Gets the line on which this element starts.

    from Locatable
    getStringValue

    If this is a string constant, gets the value of the string.

    from JsonValue
    isTopLevel

    Holds if this JSON value is the top level element in its enclosing file.

    from JsonValue
    toString

    Gets a textual representation of this element.

    from JsonValue

    Charpred