diff --git a/typedoc/classes/LiveVariables.html b/typedoc/classes/LiveVariables.html index 7de50fceac5..1f8d36a7093 100644 --- a/typedoc/classes/LiveVariables.html +++ b/typedoc/classes/LiveVariables.html @@ -1,4 +1,4 @@ -LiveVariables | SonarJS linter helper functions

Constructors

constructor +LiveVariables | SonarJS linter helper functions

Constructors

Properties

gen in kill @@ -7,9 +7,9 @@ segment

Methods

Constructors

Properties

gen: Set<Variable> = ...

variables that are being read in the block

-
in: Set<Variable> = ...

variables needed by this or a successor block and are not killed in this block

-
kill: Set<Variable> = ...

variables that are being written in the block

-
out: Variable[] = []

variables needed by successors

-
references: Set<ReferenceLike> = ...

collects references in order they are evaluated, set in JS maintains insertion order

-
segment: CodePathSegment

Methods

  • Parameters

    Returns boolean

+

Constructors

Properties

gen: Set<Variable> = ...

variables that are being read in the block

+
in: Set<Variable> = ...

variables needed by this or a successor block and are not killed in this block

+
kill: Set<Variable> = ...

variables that are being written in the block

+
out: Variable[] = []

variables needed by successors

+
references: Set<ReferenceLike> = ...

collects references in order they are evaluated, set in JS maintains insertion order

+
segment: CodePathSegment

Methods

  • Parameters

    Returns boolean

diff --git a/typedoc/classes/ReachingDefinitions.html b/typedoc/classes/ReachingDefinitions.html index 29079e72016..b12265c6545 100644 --- a/typedoc/classes/ReachingDefinitions.html +++ b/typedoc/classes/ReachingDefinitions.html @@ -1,4 +1,4 @@ -ReachingDefinitions | SonarJS linter helper functions

Constructors

constructor +ReachingDefinitions | SonarJS linter helper functions

Constructors

Properties

Constructors

Properties

in: Map<Variable, Values> = ...
out: Map<Variable, Values> = ...
references: Set<Reference> = ...

collects references in order they are evaluated, set in JS maintains insertion order

-
segment: CodePathSegment

Methods

+

Constructors

Properties

in: Map<Variable, Values> = ...
out: Map<Variable, Values> = ...
references: Set<Reference> = ...

collects references in order they are evaluated, set in JS maintains insertion order

+
segment: CodePathSegment

Methods

diff --git a/typedoc/classes/SimplifiedRegexCharacterClass.html b/typedoc/classes/SimplifiedRegexCharacterClass.html index 3dcf299af68..7464624e1eb 100644 --- a/typedoc/classes/SimplifiedRegexCharacterClass.html +++ b/typedoc/classes/SimplifiedRegexCharacterClass.html @@ -1,8 +1,8 @@ -SimplifiedRegexCharacterClass | SonarJS linter helper functions

Constructors

constructor +SimplifiedRegexCharacterClass | SonarJS linter helper functions

Constructors

Methods

  • Parameters

    • key: number
    • value: undefined | Node
    • tree: Tree<number, undefined | Node>

    Returns Tree<number, undefined | Node>

+

Constructors

Methods

  • Parameters

    • key: number
    • value: undefined | Node
    • tree: Tree<number, undefined | Node>

    Returns Tree<number, undefined | Node>

diff --git a/typedoc/functions/AwsCdkCheckArguments.html b/typedoc/functions/AwsCdkCheckArguments.html index 61a9b09dc86..1c964bd0c5f 100644 --- a/typedoc/functions/AwsCdkCheckArguments.html +++ b/typedoc/functions/AwsCdkCheckArguments.html @@ -8,4 +8,4 @@
  • Optionalvalues: ValuesByType

    allowed or disallowed values

  • silent: boolean = false

    whether the function must report or just return conflicting Node when conditions are not met

  • position: number = AWS_OPTIONS_ARGUMENT_POSITION

    position of the argument to be analysed (3rd argument by default)

    -
  • Returns ((expr: NewExpression, ctx: RuleContext) => undefined | Node)

    +

    Returns ((expr: NewExpression, ctx: RuleContext) => undefined | Node)

    diff --git a/typedoc/functions/AwsCdkTemplate.html b/typedoc/functions/AwsCdkTemplate.html index be0e0d9777d..f9c98eaaf9f 100644 --- a/typedoc/functions/AwsCdkTemplate.html +++ b/typedoc/functions/AwsCdkTemplate.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rule.RuleModule

    the instantiated rule module

    -
    +
    diff --git a/typedoc/functions/AwsIamPolicyTemplate.html b/typedoc/functions/AwsIamPolicyTemplate.html index dcadff74a94..d158ce9936c 100644 --- a/typedoc/functions/AwsIamPolicyTemplate.html +++ b/typedoc/functions/AwsIamPolicyTemplate.html @@ -1 +1 @@ -AwsIamPolicyTemplate | SonarJS linter helper functions
    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    +AwsIamPolicyTemplate | SonarJS linter helper functions
    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    diff --git a/typedoc/functions/Chai.isAssertion.html b/typedoc/functions/Chai.isAssertion.html index 29ede8c84d1..968f795aa02 100644 --- a/typedoc/functions/Chai.isAssertion.html +++ b/typedoc/functions/Chai.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    +isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    diff --git a/typedoc/functions/Chai.isImported.html b/typedoc/functions/Chai.isImported.html index 06dd7d93f66..e6ec8fc2d05 100644 --- a/typedoc/functions/Chai.isImported.html +++ b/typedoc/functions/Chai.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    +isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    diff --git a/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html b/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html index 70b8a7d7132..da5d926b654 100644 --- a/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html +++ b/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html @@ -11,4 +11,4 @@
  • message: string

    the reported message when an issue is raised

  • meta: RuleMetaData = {}

    the rule metadata

  • Returns Rule.RuleModule

    a rule module that raises issues when a sensitive property is found

    -
    +
    diff --git a/typedoc/functions/Express.attemptFindAppInjection.html b/typedoc/functions/Express.attemptFindAppInjection.html index a958b7f03b1..118e29a2fc5 100644 --- a/typedoc/functions/Express.attemptFindAppInjection.html +++ b/typedoc/functions/Express.attemptFindAppInjection.html @@ -1,3 +1,3 @@ attemptFindAppInjection | SonarJS linter helper functions
    • Checks whether the function injects an instantiated app and is exported like module.exports = function(app) {} or module.exports.property = function(app) {}, and returns app if it matches.

      -

      Parameters

      • functionDef: Function
      • context: RuleContext
      • node: Node

      Returns estree.Identifier | undefined

    +

    Parameters

    Returns estree.Identifier | undefined

    diff --git a/typedoc/functions/Express.attemptFindAppInstantiation.html b/typedoc/functions/Express.attemptFindAppInstantiation.html index 0aa495b4366..4d1619ee146 100644 --- a/typedoc/functions/Express.attemptFindAppInstantiation.html +++ b/typedoc/functions/Express.attemptFindAppInstantiation.html @@ -1,3 +1,3 @@ attemptFindAppInstantiation | SonarJS linter helper functions
    • Checks whether the declaration looks somewhat like <id> = express() and returns <id> if it matches.

      -

      Parameters

      • varDecl: VariableDeclarator
      • context: RuleContext

      Returns estree.Identifier | undefined

    +

    Parameters

    Returns estree.Identifier | undefined

    diff --git a/typedoc/functions/Express.isMiddlewareInstance.html b/typedoc/functions/Express.isMiddlewareInstance.html index 9f5ee706e04..4f5a44dc756 100644 --- a/typedoc/functions/Express.isMiddlewareInstance.html +++ b/typedoc/functions/Express.isMiddlewareInstance.html @@ -1,3 +1,3 @@ isMiddlewareInstance | SonarJS linter helper functions
    • Checks whether a node looks somewhat like require('m')() for some middleware m from the list of middlewares.

      -

      Parameters

      • context: RuleContext
      • middlewares: string[]
      • n: Node

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/Express.isUsingMiddleware.html b/typedoc/functions/Express.isUsingMiddleware.html index 90af307c287..fe929e5abc8 100644 --- a/typedoc/functions/Express.isUsingMiddleware.html +++ b/typedoc/functions/Express.isUsingMiddleware.html @@ -1,3 +1,3 @@ isUsingMiddleware | SonarJS linter helper functions
    • Checks whether the expression looks somewhat like app.use(m1, [m2, m3], ..., mN), where one of mK-nodes satisfies the given predicate.

      -

      Parameters

      • context: RuleContext
      • callExpression: CallExpression
      • app: Identifier
      • middlewareNodePredicate: ((n: Node) => boolean)
          • (n): boolean
          • Parameters

            • n: Node

            Returns boolean

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/Mocha.extractTestCase.html b/typedoc/functions/Mocha.extractTestCase.html index f826e08e7fd..9482550fdd1 100644 --- a/typedoc/functions/Mocha.extractTestCase.html +++ b/typedoc/functions/Mocha.extractTestCase.html @@ -1 +1 @@ -extractTestCase | SonarJS linter helper functions
    +extractTestCase | SonarJS linter helper functions
    diff --git a/typedoc/functions/Mocha.isDescribeCase.html b/typedoc/functions/Mocha.isDescribeCase.html index bf8c54bbb39..101c1d8765c 100644 --- a/typedoc/functions/Mocha.isDescribeCase.html +++ b/typedoc/functions/Mocha.isDescribeCase.html @@ -1,2 +1,2 @@ isDescribeCase | SonarJS linter helper functions
    • returns true if the node is a describe block

      -

      Parameters

      • node: Node

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/Mocha.isTestCase.html b/typedoc/functions/Mocha.isTestCase.html index fe6502fa84b..684c9beb8f8 100644 --- a/typedoc/functions/Mocha.isTestCase.html +++ b/typedoc/functions/Mocha.isTestCase.html @@ -1,2 +1,2 @@ isTestCase | SonarJS linter helper functions
    • returns true if the node is a test case

      -

      Parameters

      • node: Node

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/Mocha.isTestConstruct.html b/typedoc/functions/Mocha.isTestConstruct.html index 7db2119730b..8be9d08f7c6 100644 --- a/typedoc/functions/Mocha.isTestConstruct.html +++ b/typedoc/functions/Mocha.isTestConstruct.html @@ -1 +1 @@ -isTestConstruct | SonarJS linter helper functions
    • Parameters

      • node: Node
      • constructs: string[] = TEST_CONSTRUCTS

      Returns boolean

    +isTestConstruct | SonarJS linter helper functions
    • Parameters

      • node: Node
      • constructs: string[] = TEST_CONSTRUCTS

      Returns boolean

    diff --git a/typedoc/functions/S3BucketTemplate.html b/typedoc/functions/S3BucketTemplate.html index 30270085d6d..6e569ea9a65 100644 --- a/typedoc/functions/S3BucketTemplate.html +++ b/typedoc/functions/S3BucketTemplate.html @@ -5,4 +5,4 @@

    Parameters

    Returns Rule.RuleModule

    the instantiated rule definition

    -
    +
    diff --git a/typedoc/functions/Sinon.isAssertion.html b/typedoc/functions/Sinon.isAssertion.html index 78eaa629b9d..2582d277f98 100644 --- a/typedoc/functions/Sinon.isAssertion.html +++ b/typedoc/functions/Sinon.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    +isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    diff --git a/typedoc/functions/Sinon.isImported.html b/typedoc/functions/Sinon.isImported.html index 93cfb8664e7..0a1b020db1f 100644 --- a/typedoc/functions/Sinon.isImported.html +++ b/typedoc/functions/Sinon.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    +isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    diff --git a/typedoc/functions/Vitest.isAssertion.html b/typedoc/functions/Vitest.isAssertion.html index 582dc09ca05..fadc13d5e2f 100644 --- a/typedoc/functions/Vitest.isAssertion.html +++ b/typedoc/functions/Vitest.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    +isAssertion | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    diff --git a/typedoc/functions/Vitest.isImported.html b/typedoc/functions/Vitest.isImported.html index 93a2bc4172a..4c4416aedda 100644 --- a/typedoc/functions/Vitest.isImported.html +++ b/typedoc/functions/Vitest.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    +isImported | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns boolean

    diff --git a/typedoc/functions/ancestorsChain.html b/typedoc/functions/ancestorsChain.html index e60b446e8c7..8177c44ea56 100644 --- a/typedoc/functions/ancestorsChain.html +++ b/typedoc/functions/ancestorsChain.html @@ -1 +1 @@ -ancestorsChain | SonarJS linter helper functions
    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    +ancestorsChain | SonarJS linter helper functions
    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    diff --git a/typedoc/functions/areEquivalent.html b/typedoc/functions/areEquivalent.html index bf07758da48..75a116624a5 100644 --- a/typedoc/functions/areEquivalent.html +++ b/typedoc/functions/areEquivalent.html @@ -1,4 +1,4 @@ areEquivalent | SonarJS linter helper functions
    • Equivalence is implemented by comparing node types and their tokens. Classic implementation would recursively compare children, but "estree" doesn't provide access to children when node type is unknown

      -

      Parameters

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/checkSensitiveCall.html b/typedoc/functions/checkSensitiveCall.html index c45dad29eb4..e64098c3959 100644 --- a/typedoc/functions/checkSensitiveCall.html +++ b/typedoc/functions/checkSensitiveCall.html @@ -1 +1 @@ -checkSensitiveCall | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • callExpression: CallExpression
      • sensitiveArgumentIndex: number
      • sensitiveProperty: string
      • sensitivePropertyValue: boolean
      • message: string

      Returns void

    +checkSensitiveCall | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • callExpression: CallExpression
      • sensitiveArgumentIndex: number
      • sensitiveProperty: string
      • sensitivePropertyValue: boolean
      • message: string

      Returns void

    diff --git a/typedoc/functions/childrenOf.html b/typedoc/functions/childrenOf.html index a73a0e1087b..50e4b91c21a 100644 --- a/typedoc/functions/childrenOf.html +++ b/typedoc/functions/childrenOf.html @@ -2,4 +2,4 @@

    Parameters

    Returns estree.Node[]

    the node children

    -
    +
    diff --git a/typedoc/functions/collectIfBranches.html b/typedoc/functions/collectIfBranches.html index 3b696d29502..d9d23034460 100644 --- a/typedoc/functions/collectIfBranches.html +++ b/typedoc/functions/collectIfBranches.html @@ -1,2 +1,2 @@ collectIfBranches | SonarJS linter helper functions
    • Returns a list of statements corresponding to a if - else if - else chain

      -

      Parameters

      • node: IfStatement

      Returns {
          branches: Statement[];
          endsWithElse: boolean;
      }

      • branches: Statement[]
      • endsWithElse: boolean
    +

    Parameters

    Returns {
        branches: Statement[];
        endsWithElse: boolean;
    }

    diff --git a/typedoc/functions/collectSwitchBranches.html b/typedoc/functions/collectSwitchBranches.html index 9503b631cc9..dbdde01206f 100644 --- a/typedoc/functions/collectSwitchBranches.html +++ b/typedoc/functions/collectSwitchBranches.html @@ -1,2 +1,2 @@ collectSwitchBranches | SonarJS linter helper functions
    • Returns a list of switch clauses (both case and default)

      -

      Parameters

      • node: SwitchStatement

      Returns {
          branches: Statement[][];
          endsWithDefault: boolean;
      }

      • branches: Statement[][]
      • endsWithDefault: boolean
    +

    Parameters

    Returns {
        branches: Statement[][];
        endsWithDefault: boolean;
    }

    diff --git a/typedoc/functions/createRegExpRule.html b/typedoc/functions/createRegExpRule.html index 3b57b1875dc..f84ad2f33c1 100644 --- a/typedoc/functions/createRegExpRule.html +++ b/typedoc/functions/createRegExpRule.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rule.RuleModule

    the resulting rule module

    -
    +
    diff --git a/typedoc/functions/encodeContents.html b/typedoc/functions/encodeContents.html index 52d23821d82..a2030f831bb 100644 --- a/typedoc/functions/encodeContents.html +++ b/typedoc/functions/encodeContents.html @@ -1 +1 @@ -encodeContents | SonarJS linter helper functions
    • Parameters

      • message: string
      • OptionalsecondaryLocations: IssueLocation[]
      • Optionalcost: number

      Returns string

    +encodeContents | SonarJS linter helper functions
    • Parameters

      • message: string
      • OptionalsecondaryLocations: IssueLocation[]
      • Optionalcost: number

      Returns string

    diff --git a/typedoc/functions/expandMessage.html b/typedoc/functions/expandMessage.html index 060e2da11aa..73a904e5aab 100644 --- a/typedoc/functions/expandMessage.html +++ b/typedoc/functions/expandMessage.html @@ -1 +1 @@ -expandMessage | SonarJS linter helper functions
    • Parameters

      • message: string
      • reportDescriptorData: undefined | Record<string, unknown>

      Returns string

    +expandMessage | SonarJS linter helper functions
    • Parameters

      • message: string
      • reportDescriptorData: undefined | Record<string, unknown>

      Returns string

    diff --git a/typedoc/functions/extractReferences.html b/typedoc/functions/extractReferences.html index 7c69cffde39..a5ee45605b9 100644 --- a/typedoc/functions/extractReferences.html +++ b/typedoc/functions/extractReferences.html @@ -1 +1 @@ -extractReferences | SonarJS linter helper functions
    +extractReferences | SonarJS linter helper functions
    diff --git a/typedoc/functions/findFirstMatchingAncestor.html b/typedoc/functions/findFirstMatchingAncestor.html index 177116f20c8..85c68fc015e 100644 --- a/typedoc/functions/findFirstMatchingAncestor.html +++ b/typedoc/functions/findFirstMatchingAncestor.html @@ -1 +1 @@ -findFirstMatchingAncestor | SonarJS linter helper functions
    • Parameters

      • node: Node
      • predicate: ((node: Node) => boolean)
          • (node): boolean
          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    +findFirstMatchingAncestor | SonarJS linter helper functions
    • Parameters

      • node: Node
      • predicate: ((node: Node) => boolean)
          • (node): boolean
          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    diff --git a/typedoc/functions/findFirstMatchingLocalAncestor.html b/typedoc/functions/findFirstMatchingLocalAncestor.html index f6836ca39aa..37bb28d6264 100644 --- a/typedoc/functions/findFirstMatchingLocalAncestor.html +++ b/typedoc/functions/findFirstMatchingLocalAncestor.html @@ -1 +1 @@ -findFirstMatchingLocalAncestor | SonarJS linter helper functions
    • Parameters

      • node: Node
      • predicate: ((node: Node) => boolean)
          • (node): boolean
          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    +findFirstMatchingLocalAncestor | SonarJS linter helper functions
    • Parameters

      • node: Node
      • predicate: ((node: Node) => boolean)
          • (node): boolean
          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    diff --git a/typedoc/functions/findParent.html b/typedoc/functions/findParent.html index 8566f6d6ae5..4a345921fb7 100644 --- a/typedoc/functions/findParent.html +++ b/typedoc/functions/findParent.html @@ -1,3 +1,3 @@ findParent | SonarJS linter helper functions
    • Find nearest file with a given name in current or parent dirs

      Parameters

      • dir: string
      • name: string

        filename to search for

        -

      Returns string | null

    +

    Returns string | null

    diff --git a/typedoc/functions/findPropagatedSetting.html b/typedoc/functions/findPropagatedSetting.html index 179edc5ef7f..4bc7aaf6e8b 100644 --- a/typedoc/functions/findPropagatedSetting.html +++ b/typedoc/functions/findPropagatedSetting.html @@ -1,2 +1,2 @@ findPropagatedSetting | SonarJS linter helper functions
    • Finds the propagated setting of a sensitive property

      -

      Parameters

      • sensitiveProperty: Property
      • propagatedValue: Node

      Returns IssueLocation | undefined

    +

    Parameters

    Returns IssueLocation | undefined

    diff --git a/typedoc/functions/flatMap.html b/typedoc/functions/flatMap.html index d7f43c2d3b5..c3a777e84ae 100644 --- a/typedoc/functions/flatMap.html +++ b/typedoc/functions/flatMap.html @@ -1 +1 @@ -flatMap | SonarJS linter helper functions
    • Type Parameters

      • A
      • B

      Parameters

      • xs: A[]
      • f: ((e: A) => B[])
          • (e): B[]
          • Parameters

            Returns B[]

      Returns B[]

    +flatMap | SonarJS linter helper functions
    • Type Parameters

      • A
      • B

      Parameters

      • xs: A[]
      • f: ((e: A) => B[])
          • (e): B[]
          • Parameters

            Returns B[]

      Returns B[]

    diff --git a/typedoc/functions/flattenArgs.html b/typedoc/functions/flattenArgs.html index 40255ddcd16..84226650f66 100644 --- a/typedoc/functions/flattenArgs.html +++ b/typedoc/functions/flattenArgs.html @@ -12,4 +12,4 @@

    This means that methods like app.use accept variable arguments, but also arrays, or combinations thereof. This methods helps to flatten out such complicated composed argument lists.

    -

    Parameters

    Returns estree.Node[]

    +

    Parameters

    Returns estree.Node[]

    diff --git a/typedoc/functions/generateMeta.html b/typedoc/functions/generateMeta.html index 8a5ceac1f44..0098213aaf6 100644 --- a/typedoc/functions/generateMeta.html +++ b/typedoc/functions/generateMeta.html @@ -1 +1 @@ -generateMeta | SonarJS linter helper functions
    • Parameters

      • rspecMeta: RuleMetaData
      • OptionalruleMeta: RuleMetaData
      • hasSecondaries: boolean = false

      Returns Rule.RuleMetaData

    +generateMeta | SonarJS linter helper functions
    • Parameters

      • rspecMeta: RuleMetaData
      • OptionalruleMeta: RuleMetaData
      • hasSecondaries: boolean = false

      Returns Rule.RuleMetaData

    diff --git a/typedoc/functions/getBucketProperty.html b/typedoc/functions/getBucketProperty.html index a35b8349fc9..a38bcaaa9be 100644 --- a/typedoc/functions/getBucketProperty.html +++ b/typedoc/functions/getBucketProperty.html @@ -6,4 +6,4 @@
  • bucket: NewExpression

    the invocation of S3 Bucket's constructor

  • key: string

    the key of the property to extract

  • Returns undefined | null | Property

    the extracted property

    -
    +
    diff --git a/typedoc/functions/getDependencies.html b/typedoc/functions/getDependencies.html index 02ca64b5d77..d96cb23465d 100644 --- a/typedoc/functions/getDependencies.html +++ b/typedoc/functions/getDependencies.html @@ -1,4 +1,4 @@ getDependencies | SonarJS linter helper functions
    • Retrieve the dependencies of all the package.json files available for the given file.

      Parameters

      • filename: string

        context.filename

      • cwd: string

        working dir, will search up to that root

        -

      Returns Set<string | Minimatch>

    +

    Returns Set<string | Minimatch>

    diff --git a/typedoc/functions/getDependenciesFromPackageJson.html b/typedoc/functions/getDependenciesFromPackageJson.html index 9f6679a4bb2..f8a5778d699 100644 --- a/typedoc/functions/getDependenciesFromPackageJson.html +++ b/typedoc/functions/getDependenciesFromPackageJson.html @@ -1 +1 @@ -getDependenciesFromPackageJson | SonarJS linter helper functions
    • Parameters

      • content: PackageJson

      Returns Set<string | Minimatch>

    +getDependenciesFromPackageJson | SonarJS linter helper functions
    • Parameters

      • content: PackageJson

      Returns Set<string | Minimatch>

    diff --git a/typedoc/functions/getFirstToken.html b/typedoc/functions/getFirstToken.html index a0008469b76..180d49f8b46 100644 --- a/typedoc/functions/getFirstToken.html +++ b/typedoc/functions/getFirstToken.html @@ -1 +1 @@ -getFirstToken | SonarJS linter helper functions
    • Type Parameters

      • T = string

      Parameters

      • node: Node
      • context: RuleContext<string, T[]>

      Returns TSESLint.AST.Token

    +getFirstToken | SonarJS linter helper functions
    • Type Parameters

      • T = string

      Parameters

      • node: Node
      • context: RuleContext<string, T[]>

      Returns TSESLint.AST.Token

    diff --git a/typedoc/functions/getFirstTokenAfter.html b/typedoc/functions/getFirstTokenAfter.html index e8566064841..cdc2e6f5363 100644 --- a/typedoc/functions/getFirstTokenAfter.html +++ b/typedoc/functions/getFirstTokenAfter.html @@ -1 +1 @@ -getFirstTokenAfter | SonarJS linter helper functions
    • Type Parameters

      • T = string

      Parameters

      • node: Node
      • context: RuleContext<string, T[]>

      Returns TSESLint.AST.Token | null

    +getFirstTokenAfter | SonarJS linter helper functions
    • Type Parameters

      • T = string

      Parameters

      • node: Node
      • context: RuleContext<string, T[]>

      Returns TSESLint.AST.Token | null

    diff --git a/typedoc/functions/getFlags.html b/typedoc/functions/getFlags.html index 568695446e5..a5982e70c19 100644 --- a/typedoc/functions/getFlags.html +++ b/typedoc/functions/getFlags.html @@ -1 +1 @@ -getFlags | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression
      • Optionalcontext: RuleContext

      Returns string | null

    +getFlags | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression
      • Optionalcontext: RuleContext

      Returns string | null

    diff --git a/typedoc/functions/getFullyQualifiedName.html b/typedoc/functions/getFullyQualifiedName.html index 051812566c2..1ed64c47070 100644 --- a/typedoc/functions/getFullyQualifiedName.html +++ b/typedoc/functions/getFullyQualifiedName.html @@ -12,4 +12,4 @@
  • fqn: string[] = []

    the already traversed FQN (for recursive calls)

  • Optionalscope: Scope

    scope to look for the variable definition, used in recursion not to loop over same variable always in the lower scope

    -
  • Returns string | null

    +

    Returns string | null

    diff --git a/typedoc/functions/getFullyQualifiedNameRaw.html b/typedoc/functions/getFullyQualifiedNameRaw.html index 1bcc0715e0c..5e1f31cfa5a 100644 --- a/typedoc/functions/getFullyQualifiedNameRaw.html +++ b/typedoc/functions/getFullyQualifiedNameRaw.html @@ -1,3 +1,3 @@ getFullyQualifiedNameRaw | SonarJS linter helper functions
    • Just like getFullyQualifiedName(), but does not filter out the node: prefix.

      To be used for rules that need to work with the node: prefix.

      -

      Parameters

      • context: RuleContext
      • node: Node
      • fqn: string[]
      • Optionalscope: Scope
      • visitedVars: Variable[] = []

      Returns string | null

    +

    Parameters

    Returns string | null

    diff --git a/typedoc/functions/getImportDeclarations.html b/typedoc/functions/getImportDeclarations.html index 61040f83874..44545a160ca 100644 --- a/typedoc/functions/getImportDeclarations.html +++ b/typedoc/functions/getImportDeclarations.html @@ -1 +1 @@ -getImportDeclarations | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    +getImportDeclarations | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    diff --git a/typedoc/functions/getJsxShortCircuitNodes.html b/typedoc/functions/getJsxShortCircuitNodes.html index aff33d39075..70313d06487 100644 --- a/typedoc/functions/getJsxShortCircuitNodes.html +++ b/typedoc/functions/getJsxShortCircuitNodes.html @@ -1 +1 @@ -getJsxShortCircuitNodes | SonarJS linter helper functions
    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    +getJsxShortCircuitNodes | SonarJS linter helper functions
    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    diff --git a/typedoc/functions/getLhsVariable.html b/typedoc/functions/getLhsVariable.html index 419ae19b1ac..29b7c94e7b6 100644 --- a/typedoc/functions/getLhsVariable.html +++ b/typedoc/functions/getLhsVariable.html @@ -1,2 +1,2 @@ getLhsVariable | SonarJS linter helper functions
    • for x = 42 or let x = 42 when visiting '42' returns 'x' variable

      -

      Parameters

      • context: RuleContext
      • node: Node

      Returns Scope.Variable | undefined

    +

    Parameters

    Returns Scope.Variable | undefined

    diff --git a/typedoc/functions/getLiteralValue.html b/typedoc/functions/getLiteralValue.html index 30b34d4402a..04107c0d3cf 100644 --- a/typedoc/functions/getLiteralValue.html +++ b/typedoc/functions/getLiteralValue.html @@ -1 +1 @@ -getLiteralValue | SonarJS linter helper functions
    • Parameters

      • ctx: RuleContext
      • node: Node

      Returns estree.Literal | undefined

    +getLiteralValue | SonarJS linter helper functions
    • Parameters

      • ctx: RuleContext
      • node: Node

      Returns estree.Literal | undefined

    diff --git a/typedoc/functions/getMainFunctionTokenLocation.html b/typedoc/functions/getMainFunctionTokenLocation.html index dd0742159a9..e1a67dfab4f 100644 --- a/typedoc/functions/getMainFunctionTokenLocation.html +++ b/typedoc/functions/getMainFunctionTokenLocation.html @@ -4,4 +4,4 @@
  • "function" keyword for a function expression
  • "=>" for an arrow function
  • -

    Type Parameters

    Parameters

    Returns SourceLocation

    +

    Type Parameters

    Parameters

    Returns SourceLocation

    diff --git a/typedoc/functions/getManifests.html b/typedoc/functions/getManifests.html index 64b8b02a6ab..21af5801692 100644 --- a/typedoc/functions/getManifests.html +++ b/typedoc/functions/getManifests.html @@ -1,3 +1,3 @@ getManifests | SonarJS linter helper functions

    Returns the project manifests that are used to resolve the dependencies imported by the module named filename, up to the passed working directory.

    -
    • Parameters

      • dir: string
      • OptionalworkingDirectory: string
      • OptionalfileSystem: Filesystem

      Returns PackageJson[]

    +
    diff --git a/typedoc/functions/getNodeParent.html b/typedoc/functions/getNodeParent.html index 5eb094341e9..25f27ed9b59 100644 --- a/typedoc/functions/getNodeParent.html +++ b/typedoc/functions/getNodeParent.html @@ -7,4 +7,4 @@ when it comes to the parent of a node.

    Parameters

    Returns Node

    the parent node

    -
    +
    diff --git a/typedoc/functions/getParent.html b/typedoc/functions/getParent.html index 08e5dd630af..c13daef91ef 100644 --- a/typedoc/functions/getParent.html +++ b/typedoc/functions/getParent.html @@ -1 +1 @@ -getParent | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns
          | undefined
          | MethodDefinition
          | Property
          | CatchClause
          | ClassDeclaration
          | ClassExpression
          | ClassBody
          | FunctionExpression
          | ArrowFunctionExpression
          | Identifier
          | SimpleLiteral
          | RegExpLiteral
          | BigIntLiteral
          | ArrayExpression
          | AssignmentExpression
          | AwaitExpression
          | BinaryExpression
          | SimpleCallExpression
          | NewExpression
          | ChainExpression
          | ConditionalExpression
          | ImportExpression
          | LogicalExpression
          | MemberExpression
          | MetaProperty
          | ObjectExpression
          | SequenceExpression
          | TaggedTemplateExpression
          | TemplateLiteral
          | ThisExpression
          | UnaryExpression
          | UpdateExpression
          | YieldExpression
          | FunctionDeclaration
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration
          | ImportSpecifier
          | ImportDefaultSpecifier
          | ImportNamespaceSpecifier
          | ExportSpecifier
          | ObjectPattern
          | ArrayPattern
          | RestElement
          | AssignmentPattern
          | PrivateIdentifier
          | Program
          | PropertyDefinition
          | SpreadElement
          | ExpressionStatement
          | BlockStatement
          | StaticBlock
          | EmptyStatement
          | DebuggerStatement
          | WithStatement
          | ReturnStatement
          | LabeledStatement
          | BreakStatement
          | ContinueStatement
          | IfStatement
          | SwitchStatement
          | ThrowStatement
          | TryStatement
          | WhileStatement
          | DoWhileStatement
          | ForStatement
          | ForInStatement
          | ForOfStatement
          | VariableDeclaration
          | Super
          | SwitchCase
          | TemplateElement
          | VariableDeclarator

    +getParent | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns
          | undefined
          | MethodDefinition
          | Property
          | CatchClause
          | ClassDeclaration
          | ClassExpression
          | ClassBody
          | FunctionExpression
          | ArrowFunctionExpression
          | Identifier
          | SimpleLiteral
          | RegExpLiteral
          | BigIntLiteral
          | ArrayExpression
          | AssignmentExpression
          | AwaitExpression
          | BinaryExpression
          | SimpleCallExpression
          | NewExpression
          | ChainExpression
          | ConditionalExpression
          | ImportExpression
          | LogicalExpression
          | MemberExpression
          | MetaProperty
          | ObjectExpression
          | SequenceExpression
          | TaggedTemplateExpression
          | TemplateLiteral
          | ThisExpression
          | UnaryExpression
          | UpdateExpression
          | YieldExpression
          | FunctionDeclaration
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration
          | ImportSpecifier
          | ImportDefaultSpecifier
          | ImportNamespaceSpecifier
          | ExportSpecifier
          | ObjectPattern
          | ArrayPattern
          | RestElement
          | AssignmentPattern
          | PrivateIdentifier
          | Program
          | PropertyDefinition
          | SpreadElement
          | ExpressionStatement
          | BlockStatement
          | StaticBlock
          | EmptyStatement
          | DebuggerStatement
          | WithStatement
          | ReturnStatement
          | LabeledStatement
          | BreakStatement
          | ContinueStatement
          | IfStatement
          | SwitchStatement
          | ThrowStatement
          | TryStatement
          | WhileStatement
          | DoWhileStatement
          | ForStatement
          | ForInStatement
          | ForOfStatement
          | VariableDeclaration
          | Super
          | SwitchCase
          | TemplateElement
          | VariableDeclarator

    diff --git a/typedoc/functions/getParsedRegex.html b/typedoc/functions/getParsedRegex.html index e8e23c6953a..c0e81428d1b 100644 --- a/typedoc/functions/getParsedRegex.html +++ b/typedoc/functions/getParsedRegex.html @@ -1 +1 @@ -getParsedRegex | SonarJS linter helper functions
    • Parameters

      • node: Node
      • context: RuleContext

      Returns regexpp.AST.RegExpLiteral | null

    +getParsedRegex | SonarJS linter helper functions
    • Parameters

      • node: Node
      • context: RuleContext

      Returns regexpp.AST.RegExpLiteral | null

    diff --git a/typedoc/functions/getPatternFromNode.html b/typedoc/functions/getPatternFromNode.html index bb1119060d0..0b364d8a96a 100644 --- a/typedoc/functions/getPatternFromNode.html +++ b/typedoc/functions/getPatternFromNode.html @@ -1 +1 @@ -getPatternFromNode | SonarJS linter helper functions
    • Parameters

      • node: Node
      • context: RuleContext

      Returns {
          flags: string;
          pattern: string;
      } | null

    +getPatternFromNode | SonarJS linter helper functions
    • Parameters

      • node: Node
      • context: RuleContext

      Returns {
          flags: string;
          pattern: string;
      } | null

    diff --git a/typedoc/functions/getProgramStatements.html b/typedoc/functions/getProgramStatements.html index 9a7b4d6c23d..e8a1b8cfb6f 100644 --- a/typedoc/functions/getProgramStatements.html +++ b/typedoc/functions/getProgramStatements.html @@ -1 +1 @@ -getProgramStatements | SonarJS linter helper functions
    • Parameters

      • program: Program

      Returns Statement[]

    +getProgramStatements | SonarJS linter helper functions
    • Parameters

      • program: Program

      Returns Statement[]

    diff --git a/typedoc/functions/getProperty.html b/typedoc/functions/getProperty.html index b167127a1ca..a34d9e62789 100644 --- a/typedoc/functions/getProperty.html +++ b/typedoc/functions/getProperty.html @@ -1,4 +1,4 @@ getProperty | SonarJS linter helper functions
    • Retrieves the property with the specified key from the given node.

      Parameters

      • expr: undefined | null | Node
      • key: string
      • ctx: RuleContext

      Returns estree.Property | null | undefined

      The property if found, or null if not found, or undefined if property not found and one of the properties is an unresolved SpreadElement.

      -
    +
    diff --git a/typedoc/functions/getPropertyWithValue.html b/typedoc/functions/getPropertyWithValue.html index aefcd49283a..fd4e2cd471e 100644 --- a/typedoc/functions/getPropertyWithValue.html +++ b/typedoc/functions/getPropertyWithValue.html @@ -1 +1 @@ -getPropertyWithValue | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • objectExpression: ObjectExpression
      • propertyName: string
      • propertyValue:
            | undefined
            | null
            | string
            | number
            | bigint
            | boolean
            | RegExp

      Returns estree.Property | undefined

    +getPropertyWithValue | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • objectExpression: ObjectExpression
      • propertyName: string
      • propertyValue:
            | undefined
            | null
            | string
            | number
            | bigint
            | boolean
            | RegExp

      Returns estree.Property | undefined

    diff --git a/typedoc/functions/getRegexpLocation.html b/typedoc/functions/getRegexpLocation.html index e2654daee3b..641fca65fa0 100644 --- a/typedoc/functions/getRegexpLocation.html +++ b/typedoc/functions/getRegexpLocation.html @@ -4,4 +4,4 @@
  • context: RuleContext

    the rule context

  • offset: number[] = ...

    an offset to apply on the location

  • Returns AST.SourceLocation | null

    the regexp node location in the ESLint referential

    -
    +
    diff --git a/typedoc/functions/getRegexpRange.html b/typedoc/functions/getRegexpRange.html index b61487d4b95..d2bb3271642 100644 --- a/typedoc/functions/getRegexpRange.html +++ b/typedoc/functions/getRegexpRange.html @@ -1,3 +1,3 @@ getRegexpRange | SonarJS linter helper functions
    • Returns the location of regexpNode relative to the node, which is regexp string or literal. If the computation of location fails, it returns the range of the whole node.

      -

      Parameters

      • node: Node
      • regexpNode: Node

      Returns AST.Range

    +

    Parameters

    Returns AST.Range

    diff --git a/typedoc/functions/getRequireCalls.html b/typedoc/functions/getRequireCalls.html index 287d5fdd655..20794fcb6d1 100644 --- a/typedoc/functions/getRequireCalls.html +++ b/typedoc/functions/getRequireCalls.html @@ -1 +1 @@ -getRequireCalls | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    +getRequireCalls | SonarJS linter helper functions
    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    diff --git a/typedoc/functions/getSensitiveEffect.html b/typedoc/functions/getSensitiveEffect.html index f36d675bef4..387ea09a807 100644 --- a/typedoc/functions/getSensitiveEffect.html +++ b/typedoc/functions/getSensitiveEffect.html @@ -1 +1 @@ -getSensitiveEffect | SonarJS linter helper functions
    +getSensitiveEffect | SonarJS linter helper functions
    diff --git a/typedoc/functions/getSignatureFromCallee.html b/typedoc/functions/getSignatureFromCallee.html index f6e8fb50d39..bc33657457b 100644 --- a/typedoc/functions/getSignatureFromCallee.html +++ b/typedoc/functions/getSignatureFromCallee.html @@ -1 +1 @@ -getSignatureFromCallee | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    +getSignatureFromCallee | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    diff --git a/typedoc/functions/getSimpleRawStringValue.html b/typedoc/functions/getSimpleRawStringValue.html index c6b11ee4a47..6f8c63d8313 100644 --- a/typedoc/functions/getSimpleRawStringValue.html +++ b/typedoc/functions/getSimpleRawStringValue.html @@ -1 +1 @@ -getSimpleRawStringValue | SonarJS linter helper functions
    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    +getSimpleRawStringValue | SonarJS linter helper functions
    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    diff --git a/typedoc/functions/getSymbolAtLocation.html b/typedoc/functions/getSymbolAtLocation.html index 49ca98a0df6..d44cbe3c50d 100644 --- a/typedoc/functions/getSymbolAtLocation.html +++ b/typedoc/functions/getSymbolAtLocation.html @@ -1 +1 @@ -getSymbolAtLocation | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    +getSymbolAtLocation | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    diff --git a/typedoc/functions/getTypeAsString.html b/typedoc/functions/getTypeAsString.html index 7383224015e..981cc026489 100644 --- a/typedoc/functions/getTypeAsString.html +++ b/typedoc/functions/getTypeAsString.html @@ -1 +1 @@ -getTypeAsString | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    +getTypeAsString | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    diff --git a/typedoc/functions/getTypeFromTreeNode.html b/typedoc/functions/getTypeFromTreeNode.html index 80549606ec2..ff42e975dc5 100644 --- a/typedoc/functions/getTypeFromTreeNode.html +++ b/typedoc/functions/getTypeFromTreeNode.html @@ -1 +1 @@ -getTypeFromTreeNode | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    +getTypeFromTreeNode | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    diff --git a/typedoc/functions/getUnionTypes.html b/typedoc/functions/getUnionTypes.html index 475101c7de0..d4096b3d04e 100644 --- a/typedoc/functions/getUnionTypes.html +++ b/typedoc/functions/getUnionTypes.html @@ -2,4 +2,4 @@ Otherwise, returns an array containing the provided type as its unique element.

    Parameters

    Returns ts.Type[]

    An array of types. It's never empty.

    -
    +
    diff --git a/typedoc/functions/getUniqueWriteReference.html b/typedoc/functions/getUniqueWriteReference.html index a95b7bccac9..8441175afc8 100644 --- a/typedoc/functions/getUniqueWriteReference.html +++ b/typedoc/functions/getUniqueWriteReference.html @@ -1 +1 @@ -getUniqueWriteReference | SonarJS linter helper functions
    • Parameters

      • variable: undefined | Variable

      Returns estree.Node | undefined

    +getUniqueWriteReference | SonarJS linter helper functions
    • Parameters

      • variable: undefined | Variable

      Returns estree.Node | undefined

    diff --git a/typedoc/functions/getUniqueWriteUsage.html b/typedoc/functions/getUniqueWriteUsage.html index df079ab2c9b..5143f6c5fc7 100644 --- a/typedoc/functions/getUniqueWriteUsage.html +++ b/typedoc/functions/getUniqueWriteUsage.html @@ -1 +1 @@ -getUniqueWriteUsage | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • name: string
      • node: Node

      Returns undefined | Node

    +getUniqueWriteUsage | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • name: string
      • node: Node

      Returns undefined | Node

    diff --git a/typedoc/functions/getUniqueWriteUsageOrNode.html b/typedoc/functions/getUniqueWriteUsageOrNode.html index c09dc055814..1a4026155ac 100644 --- a/typedoc/functions/getUniqueWriteUsageOrNode.html +++ b/typedoc/functions/getUniqueWriteUsageOrNode.html @@ -1 +1 @@ -getUniqueWriteUsageOrNode | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node
      • recursive: boolean = false

      Returns estree.Node

    +getUniqueWriteUsageOrNode | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node
      • recursive: boolean = false

      Returns estree.Node

    diff --git a/typedoc/functions/getValueOfExpression.html b/typedoc/functions/getValueOfExpression.html index 3fbc832cc4b..e34562b6fa8 100644 --- a/typedoc/functions/getValueOfExpression.html +++ b/typedoc/functions/getValueOfExpression.html @@ -1 +1 @@ -getValueOfExpression | SonarJS linter helper functions
    • Type Parameters

      • T extends
            | "FunctionDeclaration"
            | "FunctionExpression"
            | "ArrowFunctionExpression"
            | "MethodDefinition"
            | "CatchClause"
            | "ClassBody"
            | "Identifier"
            | "Literal"
            | "PrivateIdentifier"
            | "Program"
            | "Property"
            | "PropertyDefinition"
            | "SpreadElement"
            | "Super"
            | "SwitchCase"
            | "TemplateElement"
            | "VariableDeclarator"
            | "ArrayExpression"
            | "AssignmentExpression"
            | "AwaitExpression"
            | "BinaryExpression"
            | "CallExpression"
            | "ChainExpression"
            | "ClassExpression"
            | "ConditionalExpression"
            | "ImportExpression"
            | "LogicalExpression"
            | "MemberExpression"
            | "MetaProperty"
            | "NewExpression"
            | "ObjectExpression"
            | "SequenceExpression"
            | "TaggedTemplateExpression"
            | "TemplateLiteral"
            | "ThisExpression"
            | "UnaryExpression"
            | "UpdateExpression"
            | "YieldExpression"
            | "ClassDeclaration"
            | "ImportDeclaration"
            | "ExportNamedDeclaration"
            | "ExportDefaultDeclaration"
            | "ExportAllDeclaration"
            | "ImportSpecifier"
            | "ImportDefaultSpecifier"
            | "ImportNamespaceSpecifier"
            | "ExportSpecifier"
            | "ObjectPattern"
            | "ArrayPattern"
            | "RestElement"
            | "AssignmentPattern"
            | "ExpressionStatement"
            | "BlockStatement"
            | "StaticBlock"
            | "EmptyStatement"
            | "DebuggerStatement"
            | "WithStatement"
            | "ReturnStatement"
            | "LabeledStatement"
            | "BreakStatement"
            | "ContinueStatement"
            | "IfStatement"
            | "SwitchStatement"
            | "ThrowStatement"
            | "TryStatement"
            | "WhileStatement"
            | "DoWhileStatement"
            | "ForStatement"
            | "ForInStatement"
            | "ForOfStatement"
            | "VariableDeclaration"

      Parameters

      • context: RuleContext
      • expr: undefined | null | Node
      • type: T
      • recursive: boolean = false

      Returns Extract<estree.Node, {
          type: T;
      }> | undefined

    +getValueOfExpression | SonarJS linter helper functions
    • Type Parameters

      • T extends
            | "FunctionDeclaration"
            | "FunctionExpression"
            | "ArrowFunctionExpression"
            | "MethodDefinition"
            | "CatchClause"
            | "ClassBody"
            | "Identifier"
            | "Literal"
            | "PrivateIdentifier"
            | "Program"
            | "Property"
            | "PropertyDefinition"
            | "SpreadElement"
            | "Super"
            | "SwitchCase"
            | "TemplateElement"
            | "VariableDeclarator"
            | "ArrayExpression"
            | "AssignmentExpression"
            | "AwaitExpression"
            | "BinaryExpression"
            | "CallExpression"
            | "ChainExpression"
            | "ClassExpression"
            | "ConditionalExpression"
            | "ImportExpression"
            | "LogicalExpression"
            | "MemberExpression"
            | "MetaProperty"
            | "NewExpression"
            | "ObjectExpression"
            | "SequenceExpression"
            | "TaggedTemplateExpression"
            | "TemplateLiteral"
            | "ThisExpression"
            | "UnaryExpression"
            | "UpdateExpression"
            | "YieldExpression"
            | "ClassDeclaration"
            | "ImportDeclaration"
            | "ExportNamedDeclaration"
            | "ExportDefaultDeclaration"
            | "ExportAllDeclaration"
            | "ImportSpecifier"
            | "ImportDefaultSpecifier"
            | "ImportNamespaceSpecifier"
            | "ExportSpecifier"
            | "ObjectPattern"
            | "ArrayPattern"
            | "RestElement"
            | "AssignmentPattern"
            | "ExpressionStatement"
            | "BlockStatement"
            | "StaticBlock"
            | "EmptyStatement"
            | "DebuggerStatement"
            | "WithStatement"
            | "ReturnStatement"
            | "LabeledStatement"
            | "BreakStatement"
            | "ContinueStatement"
            | "IfStatement"
            | "SwitchStatement"
            | "ThrowStatement"
            | "TryStatement"
            | "WhileStatement"
            | "DoWhileStatement"
            | "ForStatement"
            | "ForInStatement"
            | "ForOfStatement"
            | "VariableDeclaration"

      Parameters

      • context: RuleContext
      • expr: undefined | null | Node
      • type: T
      • recursive: boolean = false

      Returns Extract<estree.Node, {
          type: T;
      }> | undefined

    diff --git a/typedoc/functions/getVariableFromIdentifier.html b/typedoc/functions/getVariableFromIdentifier.html index 3e301b431f0..b9828d0890b 100644 --- a/typedoc/functions/getVariableFromIdentifier.html +++ b/typedoc/functions/getVariableFromIdentifier.html @@ -1 +1 @@ -getVariableFromIdentifier | SonarJS linter helper functions
    • Parameters

      • identifier: Identifier
      • scope: Scope

      Returns undefined | Variable

    +getVariableFromIdentifier | SonarJS linter helper functions
    • Parameters

      • identifier: Identifier
      • scope: Scope

      Returns undefined | Variable

    diff --git a/typedoc/functions/getVariableFromName.html b/typedoc/functions/getVariableFromName.html index d69f6426877..5f1683de7d8 100644 --- a/typedoc/functions/getVariableFromName.html +++ b/typedoc/functions/getVariableFromName.html @@ -1 +1 @@ -getVariableFromName | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • name: string
      • node: Node

      Returns undefined | Variable

    +getVariableFromName | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • name: string
      • node: Node

      Returns undefined | Variable

    diff --git a/typedoc/functions/getVariableFromScope.html b/typedoc/functions/getVariableFromScope.html index e8cb9efbb21..6a05a85941f 100644 --- a/typedoc/functions/getVariableFromScope.html +++ b/typedoc/functions/getVariableFromScope.html @@ -1 +1 @@ -getVariableFromScope | SonarJS linter helper functions
    • Parameters

      • scope: null | Scope
      • name: string

      Returns undefined | Variable

    +getVariableFromScope | SonarJS linter helper functions
    • Parameters

      • scope: null | Scope
      • name: string

      Returns undefined | Variable

    diff --git a/typedoc/functions/interceptReport.html b/typedoc/functions/interceptReport.html index 0d8b9b17909..27e883f0b84 100644 --- a/typedoc/functions/interceptReport.html +++ b/typedoc/functions/interceptReport.html @@ -4,4 +4,4 @@
  • onReport: ReportOverrider

    replacement for context.report(descr) invocations used inside of the rule

  • OptionalcontextOverrider: ContextOverrider

    optional function to change the default context overridding mechanism

    -
  • Returns Rule.RuleModule

    +

    Returns Rule.RuleModule

    diff --git a/typedoc/functions/interceptReportForReact.html b/typedoc/functions/interceptReportForReact.html index 8798363e094..4d838055c97 100644 --- a/typedoc/functions/interceptReportForReact.html +++ b/typedoc/functions/interceptReportForReact.html @@ -1 +1 @@ -interceptReportForReact | SonarJS linter helper functions
    +interceptReportForReact | SonarJS linter helper functions
    diff --git a/typedoc/functions/isAny.html b/typedoc/functions/isAny.html index cd679bb37b7..9e3ae4ee85b 100644 --- a/typedoc/functions/isAny.html +++ b/typedoc/functions/isAny.html @@ -1 +1 @@ -isAny | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    +isAny | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    diff --git a/typedoc/functions/isAnyLiteral.html b/typedoc/functions/isAnyLiteral.html index 7799b63b7f2..aaba30ddf07 100644 --- a/typedoc/functions/isAnyLiteral.html +++ b/typedoc/functions/isAnyLiteral.html @@ -1 +1 @@ -isAnyLiteral | SonarJS linter helper functions
    +isAnyLiteral | SonarJS linter helper functions
    diff --git a/typedoc/functions/isArray.html b/typedoc/functions/isArray.html index 3156d504826..74ec1f57a72 100644 --- a/typedoc/functions/isArray.html +++ b/typedoc/functions/isArray.html @@ -1 +1 @@ -isArray | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isArray | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isArrayExpression.html b/typedoc/functions/isArrayExpression.html index 7045d44a2ed..4058056266b 100644 --- a/typedoc/functions/isArrayExpression.html +++ b/typedoc/functions/isArrayExpression.html @@ -1 +1 @@ -isArrayExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ArrayExpression

    +isArrayExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ArrayExpression

    diff --git a/typedoc/functions/isArrayLikeType.html b/typedoc/functions/isArrayLikeType.html index 98e3e83f14d..86feef65ef1 100644 --- a/typedoc/functions/isArrayLikeType.html +++ b/typedoc/functions/isArrayLikeType.html @@ -2,4 +2,4 @@ consider the union of array types and generic types extending an array type.

    Parameters

    Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isArrowFunctionExpression.html b/typedoc/functions/isArrowFunctionExpression.html index a78577b5b0c..18182384445 100644 --- a/typedoc/functions/isArrowFunctionExpression.html +++ b/typedoc/functions/isArrowFunctionExpression.html @@ -1 +1 @@ -isArrowFunctionExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ArrowFunctionExpression

    +isArrowFunctionExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ArrowFunctionExpression

    diff --git a/typedoc/functions/isBigIntArray.html b/typedoc/functions/isBigIntArray.html index 3ce22a2e921..7cbf1ee2b5a 100644 --- a/typedoc/functions/isBigIntArray.html +++ b/typedoc/functions/isBigIntArray.html @@ -1,4 +1,4 @@ isBigIntArray | SonarJS linter helper functions
    • Test if the provided type is an array of big integers.

      Parameters

      • type: Type

        A TypeScript type.

      • services: ParserServicesWithTypeInformation

        The services used to get access to the TypeScript type checker

        -

      Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isBigIntType.html b/typedoc/functions/isBigIntType.html index 339b86348c5..1a6add13ca8 100644 --- a/typedoc/functions/isBigIntType.html +++ b/typedoc/functions/isBigIntType.html @@ -1 +1 @@ -isBigIntType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    +isBigIntType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    diff --git a/typedoc/functions/isBinaryPlus.html b/typedoc/functions/isBinaryPlus.html index 1cd44c04f6c..22d61fb338c 100644 --- a/typedoc/functions/isBinaryPlus.html +++ b/typedoc/functions/isBinaryPlus.html @@ -1 +1 @@ -isBinaryPlus | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is BinaryExpression & {
          operator: "+";
      }

    +isBinaryPlus | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is BinaryExpression & {
          operator: "+";
      }

    diff --git a/typedoc/functions/isBooleanLiteral.html b/typedoc/functions/isBooleanLiteral.html index 1fafe25f9c6..8458710edd8 100644 --- a/typedoc/functions/isBooleanLiteral.html +++ b/typedoc/functions/isBooleanLiteral.html @@ -1 +1 @@ -isBooleanLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Literal & {
          value: boolean;
      }

    +isBooleanLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Literal & {
          value: boolean;
      }

    diff --git a/typedoc/functions/isBooleanLiteralType.html b/typedoc/functions/isBooleanLiteralType.html index 5ccbe4c19c7..f4ca9922786 100644 --- a/typedoc/functions/isBooleanLiteralType.html +++ b/typedoc/functions/isBooleanLiteralType.html @@ -1 +1 @@ -isBooleanLiteralType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns type is Type & {
          intrinsicName: "true" | "false";
      }

    +isBooleanLiteralType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns type is Type & {
          intrinsicName: "true" | "false";
      }

    diff --git a/typedoc/functions/isBooleanTrueType.html b/typedoc/functions/isBooleanTrueType.html index b5d2cce8b03..1480d96d025 100644 --- a/typedoc/functions/isBooleanTrueType.html +++ b/typedoc/functions/isBooleanTrueType.html @@ -1 +1 @@ -isBooleanTrueType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    +isBooleanTrueType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    diff --git a/typedoc/functions/isBooleanType.html b/typedoc/functions/isBooleanType.html index ff53a071d7c..8d09e16130d 100644 --- a/typedoc/functions/isBooleanType.html +++ b/typedoc/functions/isBooleanType.html @@ -1 +1 @@ -isBooleanType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    +isBooleanType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    diff --git a/typedoc/functions/isCallingMethod.html b/typedoc/functions/isCallingMethod.html index bf6092fccaf..3bcdbf32b47 100644 --- a/typedoc/functions/isCallingMethod.html +++ b/typedoc/functions/isCallingMethod.html @@ -1 +1 @@ -isCallingMethod | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression
      • arity: number
      • Rest...methodNames: string[]

      Returns callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    +isCallingMethod | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression
      • arity: number
      • Rest...methodNames: string[]

      Returns callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    diff --git a/typedoc/functions/isDefaultSpecifier.html b/typedoc/functions/isDefaultSpecifier.html index c459d5b12d5..b688b5b7fe8 100644 --- a/typedoc/functions/isDefaultSpecifier.html +++ b/typedoc/functions/isDefaultSpecifier.html @@ -1 +1 @@ -isDefaultSpecifier | SonarJS linter helper functions
    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    +isDefaultSpecifier | SonarJS linter helper functions
    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    diff --git a/typedoc/functions/isDotNotation.html b/typedoc/functions/isDotNotation.html index dcb3cf738be..aecf9cb0c0d 100644 --- a/typedoc/functions/isDotNotation.html +++ b/typedoc/functions/isDotNotation.html @@ -1,2 +1,2 @@ isDotNotation | SonarJS linter helper functions
    • Checks if the node is of the form: foo.bar

      -

      Parameters

      • node: Node

      Returns node is MemberExpression & {
          property: Identifier;
      }

    +

    Parameters

    Returns node is MemberExpression & {
        property: Identifier;
    }

    diff --git a/typedoc/functions/isElementWrite.html b/typedoc/functions/isElementWrite.html index c2b8719c9b3..908a085805b 100644 --- a/typedoc/functions/isElementWrite.html +++ b/typedoc/functions/isElementWrite.html @@ -3,4 +3,4 @@ myArray[1] += 42; myObj.prop1 = 3; myObj.prop1 += 3;

    -

    Parameters

    Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/isFalseLiteral.html b/typedoc/functions/isFalseLiteral.html index dc25c6e6fe1..74ebc0ccf7a 100644 --- a/typedoc/functions/isFalseLiteral.html +++ b/typedoc/functions/isFalseLiteral.html @@ -1 +1 @@ -isFalseLiteral | SonarJS linter helper functions
    • Parameters

      • n: Node

      Returns boolean

    +isFalseLiteral | SonarJS linter helper functions
    • Parameters

      • n: Node

      Returns boolean

    diff --git a/typedoc/functions/isFunction.html b/typedoc/functions/isFunction.html index 7128d7832d3..65484a1a74a 100644 --- a/typedoc/functions/isFunction.html +++ b/typedoc/functions/isFunction.html @@ -1 +1 @@ -isFunction | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isFunction | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isFunctionCall.html b/typedoc/functions/isFunctionCall.html index 0c7d5fb9ebc..e8b22bbd7ff 100644 --- a/typedoc/functions/isFunctionCall.html +++ b/typedoc/functions/isFunctionCall.html @@ -1 +1 @@ -isFunctionCall | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is CallExpression & {
          callee: Identifier;
      }

    +isFunctionCall | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is CallExpression & {
          callee: Identifier;
      }

    diff --git a/typedoc/functions/isFunctionDeclaration.html b/typedoc/functions/isFunctionDeclaration.html index 2cc3d85dc7b..864ed4bc52b 100644 --- a/typedoc/functions/isFunctionDeclaration.html +++ b/typedoc/functions/isFunctionDeclaration.html @@ -1 +1 @@ -isFunctionDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is FunctionDeclaration

    +isFunctionDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is FunctionDeclaration

    diff --git a/typedoc/functions/isFunctionExpression.html b/typedoc/functions/isFunctionExpression.html index 3ac1ede62ee..677f64be134 100644 --- a/typedoc/functions/isFunctionExpression.html +++ b/typedoc/functions/isFunctionExpression.html @@ -1 +1 @@ -isFunctionExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is FunctionExpression

    +isFunctionExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is FunctionExpression

    diff --git a/typedoc/functions/isFunctionInvocation.html b/typedoc/functions/isFunctionInvocation.html index 4ff0aec7eb1..9f8ec58d163 100644 --- a/typedoc/functions/isFunctionInvocation.html +++ b/typedoc/functions/isFunctionInvocation.html @@ -1 +1 @@ -isFunctionInvocation | SonarJS linter helper functions
    • Parameters

      • callExpression: CallExpression
      • functionName: string
      • minArgs: number

      Returns boolean

    +isFunctionInvocation | SonarJS linter helper functions
    • Parameters

      • callExpression: CallExpression
      • functionName: string
      • minArgs: number

      Returns boolean

    diff --git a/typedoc/functions/isFunctionNode.html b/typedoc/functions/isFunctionNode.html index bfe21425753..322d7d7f71f 100644 --- a/typedoc/functions/isFunctionNode.html +++ b/typedoc/functions/isFunctionNode.html @@ -1 +1 @@ -isFunctionNode | SonarJS linter helper functions
    +isFunctionNode | SonarJS linter helper functions
    diff --git a/typedoc/functions/isGenericType.html b/typedoc/functions/isGenericType.html index d92ba602846..c98bac4ab9c 100644 --- a/typedoc/functions/isGenericType.html +++ b/typedoc/functions/isGenericType.html @@ -4,4 +4,4 @@ }

    Parameters

    Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isIdentifier.html b/typedoc/functions/isIdentifier.html index 0d615cd6995..3908448a2b2 100644 --- a/typedoc/functions/isIdentifier.html +++ b/typedoc/functions/isIdentifier.html @@ -1 +1 @@ -isIdentifier | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node
      • Rest...values: string[]

      Returns node is Identifier

    +isIdentifier | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node
      • Rest...values: string[]

      Returns node is Identifier

    diff --git a/typedoc/functions/isIfStatement.html b/typedoc/functions/isIfStatement.html index 26560df9547..aa48079c14b 100644 --- a/typedoc/functions/isIfStatement.html +++ b/typedoc/functions/isIfStatement.html @@ -1 +1 @@ -isIfStatement | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is IfStatement

    +isIfStatement | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is IfStatement

    diff --git a/typedoc/functions/isIndexNotation.html b/typedoc/functions/isIndexNotation.html index ad0eaf3ede4..84edde9a660 100644 --- a/typedoc/functions/isIndexNotation.html +++ b/typedoc/functions/isIndexNotation.html @@ -1,2 +1,2 @@ isIndexNotation | SonarJS linter helper functions
    • Checks if the node is of the form: foo["bar"]

      -

      Parameters

      • node: Node

      Returns node is MemberExpression & {
          property: StringLiteral;
      }

    +

    Parameters

    Returns node is MemberExpression & {
        property: StringLiteral;
    }

    diff --git a/typedoc/functions/isInsideVueSetupScript.html b/typedoc/functions/isInsideVueSetupScript.html index 142be9c9f48..54f0a5e2322 100644 --- a/typedoc/functions/isInsideVueSetupScript.html +++ b/typedoc/functions/isInsideVueSetupScript.html @@ -1 +1 @@ -isInsideVueSetupScript | SonarJS linter helper functions
    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    +isInsideVueSetupScript | SonarJS linter helper functions
    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    diff --git a/typedoc/functions/isLiteral.html b/typedoc/functions/isLiteral.html index 612192ec9bb..5f8bfbe9df8 100644 --- a/typedoc/functions/isLiteral.html +++ b/typedoc/functions/isLiteral.html @@ -1 +1 @@ -isLiteral | SonarJS linter helper functions
    • Parameters

      • n: null | Node

      Returns n is Literal

    +isLiteral | SonarJS linter helper functions
    • Parameters

      • n: null | Node

      Returns n is Literal

    diff --git a/typedoc/functions/isLogicalExpression.html b/typedoc/functions/isLogicalExpression.html index fa7ec470c24..a652b6cebb9 100644 --- a/typedoc/functions/isLogicalExpression.html +++ b/typedoc/functions/isLogicalExpression.html @@ -1 +1 @@ -isLogicalExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is LogicalExpression

    +isLogicalExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is LogicalExpression

    diff --git a/typedoc/functions/isMemberExpression.html b/typedoc/functions/isMemberExpression.html index b1e7267e3f4..06f4a4b3422 100644 --- a/typedoc/functions/isMemberExpression.html +++ b/typedoc/functions/isMemberExpression.html @@ -1 +1 @@ -isMemberExpression | SonarJS linter helper functions
    • Parameters

      • node: Node
      • objectValue: string
      • Rest...propertyValue: string[]

      Returns boolean

    +isMemberExpression | SonarJS linter helper functions
    • Parameters

      • node: Node
      • objectValue: string
      • Rest...propertyValue: string[]

      Returns boolean

    diff --git a/typedoc/functions/isMemberWithProperty.html b/typedoc/functions/isMemberWithProperty.html index 65bc07a7b25..eb1ff4af43b 100644 --- a/typedoc/functions/isMemberWithProperty.html +++ b/typedoc/functions/isMemberWithProperty.html @@ -1 +1 @@ -isMemberWithProperty | SonarJS linter helper functions
    • Parameters

      • node: Node
      • Rest...values: string[]

      Returns boolean

    +isMemberWithProperty | SonarJS linter helper functions
    • Parameters

      • node: Node
      • Rest...values: string[]

      Returns boolean

    diff --git a/typedoc/functions/isMethodCall.html b/typedoc/functions/isMethodCall.html index 6fec0e167a2..d561edc1490 100644 --- a/typedoc/functions/isMethodCall.html +++ b/typedoc/functions/isMethodCall.html @@ -1 +1 @@ -isMethodCall | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression

      Returns callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    +isMethodCall | SonarJS linter helper functions
    • Parameters

      • callExpr: CallExpression

      Returns callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    diff --git a/typedoc/functions/isMethodInvocation.html b/typedoc/functions/isMethodInvocation.html index f95e58dfdb5..c3fe821825e 100644 --- a/typedoc/functions/isMethodInvocation.html +++ b/typedoc/functions/isMethodInvocation.html @@ -1 +1 @@ -isMethodInvocation | SonarJS linter helper functions
    • Parameters

      • callExpression: CallExpression
      • objectIdentifierName: string
      • methodName: string
      • minArgs: number

      Returns boolean

    +isMethodInvocation | SonarJS linter helper functions
    • Parameters

      • callExpression: CallExpression
      • objectIdentifierName: string
      • methodName: string
      • minArgs: number

      Returns boolean

    diff --git a/typedoc/functions/isModuleDeclaration.html b/typedoc/functions/isModuleDeclaration.html index 961758be080..31539bcacfd 100644 --- a/typedoc/functions/isModuleDeclaration.html +++ b/typedoc/functions/isModuleDeclaration.html @@ -1 +1 @@ -isModuleDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    +isModuleDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    diff --git a/typedoc/functions/isModuleExports.html b/typedoc/functions/isModuleExports.html index 31cd73e90ef..cafddfd1665 100644 --- a/typedoc/functions/isModuleExports.html +++ b/typedoc/functions/isModuleExports.html @@ -1 +1 @@ -isModuleExports | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns boolean

    +isModuleExports | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns boolean

    diff --git a/typedoc/functions/isNamespaceSpecifier.html b/typedoc/functions/isNamespaceSpecifier.html index 90b84a97bd5..c2df46ffd3f 100644 --- a/typedoc/functions/isNamespaceSpecifier.html +++ b/typedoc/functions/isNamespaceSpecifier.html @@ -1 +1 @@ -isNamespaceSpecifier | SonarJS linter helper functions
    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    +isNamespaceSpecifier | SonarJS linter helper functions
    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    diff --git a/typedoc/functions/isNullLiteral.html b/typedoc/functions/isNullLiteral.html index cd0e44dc852..d517ad856fd 100644 --- a/typedoc/functions/isNullLiteral.html +++ b/typedoc/functions/isNullLiteral.html @@ -1 +1 @@ -isNullLiteral | SonarJS linter helper functions
    • Parameters

      • n: Node

      Returns boolean

    +isNullLiteral | SonarJS linter helper functions
    • Parameters

      • n: Node

      Returns boolean

    diff --git a/typedoc/functions/isNullOrUndefinedType.html b/typedoc/functions/isNullOrUndefinedType.html index 328cbdf3f0d..352eaada1ef 100644 --- a/typedoc/functions/isNullOrUndefinedType.html +++ b/typedoc/functions/isNullOrUndefinedType.html @@ -1 +1 @@ -isNullOrUndefinedType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    +isNullOrUndefinedType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    diff --git a/typedoc/functions/isNumber.html b/typedoc/functions/isNumber.html index 49c428dceeb..cda9877f959 100644 --- a/typedoc/functions/isNumber.html +++ b/typedoc/functions/isNumber.html @@ -1 +1 @@ -isNumber | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isNumber | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isNumberArray.html b/typedoc/functions/isNumberArray.html index 60c9484e9e5..c27889443be 100644 --- a/typedoc/functions/isNumberArray.html +++ b/typedoc/functions/isNumberArray.html @@ -1,4 +1,4 @@ isNumberArray | SonarJS linter helper functions
    • Test if the provided type is an array of numbers.

      Parameters

      • type: Type

        A TypeScript type.

      • services: ParserServicesWithTypeInformation

        The services used to get access to the TypeScript type checker

        -

      Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isNumberLiteral.html b/typedoc/functions/isNumberLiteral.html index 5378c818d06..a65f47bdc7b 100644 --- a/typedoc/functions/isNumberLiteral.html +++ b/typedoc/functions/isNumberLiteral.html @@ -1 +1 @@ -isNumberLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Literal & {
          value: number;
      }

    +isNumberLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Literal & {
          value: number;
      }

    diff --git a/typedoc/functions/isNumberType.html b/typedoc/functions/isNumberType.html index 737dac42c88..7c57485a7fc 100644 --- a/typedoc/functions/isNumberType.html +++ b/typedoc/functions/isNumberType.html @@ -1 +1 @@ -isNumberType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    +isNumberType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    diff --git a/typedoc/functions/isObjectDestructuring.html b/typedoc/functions/isObjectDestructuring.html index 456a9c53db3..f77dbb89872 100644 --- a/typedoc/functions/isObjectDestructuring.html +++ b/typedoc/functions/isObjectDestructuring.html @@ -1 +1 @@ -isObjectDestructuring | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is VariableDeclarator & {
          id: ObjectPattern;
      } | AssignmentExpression & {
          left: ObjectPattern;
      }

    +isObjectDestructuring | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is VariableDeclarator & {
          id: ObjectPattern;
      } | AssignmentExpression & {
          left: ObjectPattern;
      }

    diff --git a/typedoc/functions/isObjectType.html b/typedoc/functions/isObjectType.html index d30501145de..e36c6c8a61e 100644 --- a/typedoc/functions/isObjectType.html +++ b/typedoc/functions/isObjectType.html @@ -1 +1 @@ -isObjectType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    +isObjectType | SonarJS linter helper functions
    • Parameters

      • __namedParameters: Type

      Returns number

    diff --git a/typedoc/functions/isPresentationTable.html b/typedoc/functions/isPresentationTable.html index 3a9cf737b17..897fa40ae25 100644 --- a/typedoc/functions/isPresentationTable.html +++ b/typedoc/functions/isPresentationTable.html @@ -1 +1 @@ -isPresentationTable | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    +isPresentationTable | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    diff --git a/typedoc/functions/isProperty.html b/typedoc/functions/isProperty.html index 76d8bb2ff2e..d500afb1889 100644 --- a/typedoc/functions/isProperty.html +++ b/typedoc/functions/isProperty.html @@ -1 +1 @@ -isProperty | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Property

    +isProperty | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is Property

    diff --git a/typedoc/functions/isReferenceTo.html b/typedoc/functions/isReferenceTo.html index 8de9447e289..60934f69c14 100644 --- a/typedoc/functions/isReferenceTo.html +++ b/typedoc/functions/isReferenceTo.html @@ -1 +1 @@ -isReferenceTo | SonarJS linter helper functions
    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    +isReferenceTo | SonarJS linter helper functions
    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    diff --git a/typedoc/functions/isRegExpConstructor.html b/typedoc/functions/isRegExpConstructor.html index f6414874ee0..bbc3d29028c 100644 --- a/typedoc/functions/isRegExpConstructor.html +++ b/typedoc/functions/isRegExpConstructor.html @@ -1 +1 @@ -isRegExpConstructor | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is CallExpression

    +isRegExpConstructor | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is CallExpression

    diff --git a/typedoc/functions/isRegexLiteral.html b/typedoc/functions/isRegexLiteral.html index 40a6181b8a7..bce1122884f 100644 --- a/typedoc/functions/isRegexLiteral.html +++ b/typedoc/functions/isRegexLiteral.html @@ -1 +1 @@ -isRegexLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is RegExpLiteral

    +isRegexLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is RegExpLiteral

    diff --git a/typedoc/functions/isRequire.html b/typedoc/functions/isRequire.html index ed817a18e14..55e232fce36 100644 --- a/typedoc/functions/isRequire.html +++ b/typedoc/functions/isRequire.html @@ -1 +1 @@ -isRequire | SonarJS linter helper functions
    • Parameters

      Returns node is CallExpression

    +isRequire | SonarJS linter helper functions
    • Parameters

      Returns node is CallExpression

    diff --git a/typedoc/functions/isRequireModule.html b/typedoc/functions/isRequireModule.html index e7ab93848b2..aca32b11a19 100644 --- a/typedoc/functions/isRequireModule.html +++ b/typedoc/functions/isRequireModule.html @@ -1 +1 @@ -isRequireModule | SonarJS linter helper functions
    • Parameters

      • node: CallExpression
      • Rest...moduleNames: string[]

      Returns boolean

    +isRequireModule | SonarJS linter helper functions
    • Parameters

      • node: CallExpression
      • Rest...moduleNames: string[]

      Returns boolean

    diff --git a/typedoc/functions/isRequiredParserServices.html b/typedoc/functions/isRequiredParserServices.html index 7e7dc93472c..edb5cf3a7be 100644 --- a/typedoc/functions/isRequiredParserServices.html +++ b/typedoc/functions/isRequiredParserServices.html @@ -1 +1 @@ -isRequiredParserServices | SonarJS linter helper functions
    • Parameters

      • services: undefined | ParserServices

      Returns services is ParserServicesWithTypeInformation

    +isRequiredParserServices | SonarJS linter helper functions
    • Parameters

      • services: undefined | ParserServices

      Returns services is ParserServicesWithTypeInformation

    diff --git a/typedoc/functions/isRoot.html b/typedoc/functions/isRoot.html index 868a85fde3c..614686d6329 100644 --- a/typedoc/functions/isRoot.html +++ b/typedoc/functions/isRoot.html @@ -1 +1 @@ -isRoot | SonarJS linter helper functions
    • Parameters

      • file: string

      Returns boolean

    +isRoot | SonarJS linter helper functions
    • Parameters

      • file: string

      Returns boolean

    diff --git a/typedoc/functions/isS3BucketConstructor.html b/typedoc/functions/isS3BucketConstructor.html index b22341ae64e..5820f119844 100644 --- a/typedoc/functions/isS3BucketConstructor.html +++ b/typedoc/functions/isS3BucketConstructor.html @@ -1,4 +1,4 @@ isS3BucketConstructor | SonarJS linter helper functions
    • Detects S3 Bucket's constructor invocation from 'aws-cdk-lib/aws-s3':

      const s3 = require('aws-cdk-lib/aws-s3'); new s3.Bucket();

      -

      Parameters

      • context: RuleContext
      • node: NewExpression

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/isS3BucketDeploymentConstructor.html b/typedoc/functions/isS3BucketDeploymentConstructor.html index 8907a26ba48..7aa1b14f883 100644 --- a/typedoc/functions/isS3BucketDeploymentConstructor.html +++ b/typedoc/functions/isS3BucketDeploymentConstructor.html @@ -1,4 +1,4 @@ isS3BucketDeploymentConstructor | SonarJS linter helper functions
    • Detects S3 BucketDeployment's constructor invocation from 'aws-cdk-lib/aws-s3-deployment':

      const s3 = require('aws-cdk-lib/aws-s3-deployment'); new s3.BucketDeployment();

      -

      Parameters

      • context: RuleContext
      • node: NewExpression

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/isSimpleRawString.html b/typedoc/functions/isSimpleRawString.html index cb700bcaa81..d8d49294677 100644 --- a/typedoc/functions/isSimpleRawString.html +++ b/typedoc/functions/isSimpleRawString.html @@ -1 +1 @@ -isSimpleRawString | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is TaggedTemplateExpression

    +isSimpleRawString | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is TaggedTemplateExpression

    diff --git a/typedoc/functions/isStaticTemplateLiteral.html b/typedoc/functions/isStaticTemplateLiteral.html index fe324452949..249c074df3c 100644 --- a/typedoc/functions/isStaticTemplateLiteral.html +++ b/typedoc/functions/isStaticTemplateLiteral.html @@ -1 +1 @@ -isStaticTemplateLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is TemplateLiteral

    +isStaticTemplateLiteral | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is TemplateLiteral

    diff --git a/typedoc/functions/isString.html b/typedoc/functions/isString.html index 9b366c52e4b..501b38c87c9 100644 --- a/typedoc/functions/isString.html +++ b/typedoc/functions/isString.html @@ -1 +1 @@ -isString | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isString | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isStringArray.html b/typedoc/functions/isStringArray.html index 0797c2e8759..b6322473358 100644 --- a/typedoc/functions/isStringArray.html +++ b/typedoc/functions/isStringArray.html @@ -1,4 +1,4 @@ isStringArray | SonarJS linter helper functions
    • Test if the provided type is an array of strings.

      Parameters

      • type: Type

        A TypeScript type.

      • services: ParserServicesWithTypeInformation

        The services used to get access to the TypeScript type checker

        -

      Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isStringLiteral.html b/typedoc/functions/isStringLiteral.html index b20e6335dc6..9e43401a7d6 100644 --- a/typedoc/functions/isStringLiteral.html +++ b/typedoc/functions/isStringLiteral.html @@ -1 +1 @@ -isStringLiteral | SonarJS linter helper functions
    +isStringLiteral | SonarJS linter helper functions
    diff --git a/typedoc/functions/isStringRegexMethodCall.html b/typedoc/functions/isStringRegexMethodCall.html index 9aa33e51019..c2cded561c4 100644 --- a/typedoc/functions/isStringRegexMethodCall.html +++ b/typedoc/functions/isStringRegexMethodCall.html @@ -1 +1 @@ -isStringRegexMethodCall | SonarJS linter helper functions
    • Parameters

      • call: CallExpression
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isStringRegexMethodCall | SonarJS linter helper functions
    • Parameters

      • call: CallExpression
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isStringReplaceCall.html b/typedoc/functions/isStringReplaceCall.html index 6b547c838da..bca542fa7c7 100644 --- a/typedoc/functions/isStringReplaceCall.html +++ b/typedoc/functions/isStringReplaceCall.html @@ -1 +1 @@ -isStringReplaceCall | SonarJS linter helper functions
    • Parameters

      • call: CallExpression
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isStringReplaceCall | SonarJS linter helper functions
    • Parameters

      • call: CallExpression
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isStringType.html b/typedoc/functions/isStringType.html index 6daeb583773..df7952d371f 100644 --- a/typedoc/functions/isStringType.html +++ b/typedoc/functions/isStringType.html @@ -1 +1 @@ -isStringType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    +isStringType | SonarJS linter helper functions
    • Parameters

      • type: Type

      Returns boolean

    diff --git a/typedoc/functions/isSupported.html b/typedoc/functions/isSupported.html index 61fc17ee424..1f50b3c7cef 100644 --- a/typedoc/functions/isSupported.html +++ b/typedoc/functions/isSupported.html @@ -1,3 +1,3 @@ isSupported | SonarJS linter helper functions
    • Checks if context where the filename is located supports the provided minimum versions.

      -

      Parameters

      • dirname: string
      • minVersions: MinimumVersions

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/isThenable.html b/typedoc/functions/isThenable.html index 4942600c958..27a0163c5fd 100644 --- a/typedoc/functions/isThenable.html +++ b/typedoc/functions/isThenable.html @@ -1 +1 @@ -isThenable | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isThenable | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isThisExpression.html b/typedoc/functions/isThisExpression.html index 5cff7d94686..e6c61d0b7d8 100644 --- a/typedoc/functions/isThisExpression.html +++ b/typedoc/functions/isThisExpression.html @@ -1 +1 @@ -isThisExpression | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is ThisExpression

    +isThisExpression | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns node is ThisExpression

    diff --git a/typedoc/functions/isThrowStatement.html b/typedoc/functions/isThrowStatement.html index 6e465f9bcf1..2595761e555 100644 --- a/typedoc/functions/isThrowStatement.html +++ b/typedoc/functions/isThrowStatement.html @@ -1 +1 @@ -isThrowStatement | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ThrowStatement

    +isThrowStatement | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is ThrowStatement

    diff --git a/typedoc/functions/isTypeAlias.html b/typedoc/functions/isTypeAlias.html index dda3a6c723f..731db08fd97 100644 --- a/typedoc/functions/isTypeAlias.html +++ b/typedoc/functions/isTypeAlias.html @@ -1,4 +1,4 @@ isTypeAlias | SonarJS linter helper functions
    • Checks whether a TypeScript type node denotes a type alias.

      Parameters

      • node: TypeNode

        a type node to check

      • context: RuleContext

        the rule context

        -

      Returns undefined | boolean

    +

    Returns undefined | boolean

    diff --git a/typedoc/functions/isTypedArray.html b/typedoc/functions/isTypedArray.html index 98ba6e783a7..9f5af70b50f 100644 --- a/typedoc/functions/isTypedArray.html +++ b/typedoc/functions/isTypedArray.html @@ -1,2 +1,2 @@ isTypedArray | SonarJS linter helper functions
    • Checks if the provided node is a JS typed array like "BigInt64Array". See TYPED_ARRAY_TYPES

      -

      Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +

    Parameters

    Returns boolean

    diff --git a/typedoc/functions/isUnaryExpression.html b/typedoc/functions/isUnaryExpression.html index a551b71badc..c5befd4eeda 100644 --- a/typedoc/functions/isUnaryExpression.html +++ b/typedoc/functions/isUnaryExpression.html @@ -1 +1 @@ -isUnaryExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is UnaryExpression

    +isUnaryExpression | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is UnaryExpression

    diff --git a/typedoc/functions/isUndefined.html b/typedoc/functions/isUndefined.html index ecb6e59cbd2..81cb4319407 100644 --- a/typedoc/functions/isUndefined.html +++ b/typedoc/functions/isUndefined.html @@ -1 +1 @@ -isUndefined | SonarJS linter helper functions
    • Parameters

      Returns boolean

    +isUndefined | SonarJS linter helper functions
    • Parameters

      Returns boolean

    diff --git a/typedoc/functions/isUndefinedOrNull.html b/typedoc/functions/isUndefinedOrNull.html index 7e1ad4b4b85..028440de2ab 100644 --- a/typedoc/functions/isUndefinedOrNull.html +++ b/typedoc/functions/isUndefinedOrNull.html @@ -1 +1 @@ -isUndefinedOrNull | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isUndefinedOrNull | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isUnion.html b/typedoc/functions/isUnion.html index 2e7c9e94244..8531d5d1377 100644 --- a/typedoc/functions/isUnion.html +++ b/typedoc/functions/isUnion.html @@ -1 +1 @@ -isUnion | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    +isUnion | SonarJS linter helper functions
    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    diff --git a/typedoc/functions/isUnresolved.html b/typedoc/functions/isUnresolved.html index 54d85c40ad0..024a18084d0 100644 --- a/typedoc/functions/isUnresolved.html +++ b/typedoc/functions/isUnresolved.html @@ -6,4 +6,4 @@

    Parameters

    Returns boolean

    +

    Returns boolean

    diff --git a/typedoc/functions/isVariableDeclaration.html b/typedoc/functions/isVariableDeclaration.html index e113f799852..cad370a7a1e 100644 --- a/typedoc/functions/isVariableDeclaration.html +++ b/typedoc/functions/isVariableDeclaration.html @@ -1 +1 @@ -isVariableDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is VariableDeclaration

    +isVariableDeclaration | SonarJS linter helper functions
    • Parameters

      • node: undefined | Node

      Returns node is VariableDeclaration

    diff --git a/typedoc/functions/last.html b/typedoc/functions/last.html index 1afa6d160c5..ca9098463b4 100644 --- a/typedoc/functions/last.html +++ b/typedoc/functions/last.html @@ -1 +1 @@ -last | SonarJS linter helper functions
    +last | SonarJS linter helper functions
    diff --git a/typedoc/functions/localAncestorsChain.html b/typedoc/functions/localAncestorsChain.html index afa0a4e82a9..cefeeef5bee 100644 --- a/typedoc/functions/localAncestorsChain.html +++ b/typedoc/functions/localAncestorsChain.html @@ -1 +1 @@ -localAncestorsChain | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns Node[]

    +localAncestorsChain | SonarJS linter helper functions
    • Parameters

      • node: Node

      Returns Node[]

    diff --git a/typedoc/functions/lva.html b/typedoc/functions/lva.html index d10f50af2ab..376b1ab7e27 100644 --- a/typedoc/functions/lva.html +++ b/typedoc/functions/lva.html @@ -1 +1 @@ -lva | SonarJS linter helper functions
    • Parameters

      Returns void

    +lva | SonarJS linter helper functions
    • Parameters

      Returns void

    diff --git a/typedoc/functions/mergeRules.html b/typedoc/functions/mergeRules.html index dcde53186c3..0262bf37915 100644 --- a/typedoc/functions/mergeRules.html +++ b/typedoc/functions/mergeRules.html @@ -7,4 +7,4 @@ listen to CallExpression node visits. They will be run one after the other.

    Parameters

    Returns Rule.RuleListener

    the merge of the rules' listeners

    -
    +
    diff --git a/typedoc/functions/normalizeFQN.html b/typedoc/functions/normalizeFQN.html index b09da120845..050fae03da1 100644 --- a/typedoc/functions/normalizeFQN.html +++ b/typedoc/functions/normalizeFQN.html @@ -1 +1 @@ -normalizeFQN | SonarJS linter helper functions
    • Parameters

      • Optionalfqn: null | string

      Returns undefined | string

    +normalizeFQN | SonarJS linter helper functions
    • Parameters

      • Optionalfqn: null | string

      Returns undefined | string

    diff --git a/typedoc/functions/reachingDefinitions-1.html b/typedoc/functions/reachingDefinitions-1.html index e1ef453866e..ddf6999cd9a 100644 --- a/typedoc/functions/reachingDefinitions-1.html +++ b/typedoc/functions/reachingDefinitions-1.html @@ -1 +1 @@ -reachingDefinitions | SonarJS linter helper functions
    +reachingDefinitions | SonarJS linter helper functions
    diff --git a/typedoc/functions/readFileSync.html b/typedoc/functions/readFileSync.html index f029aca51b2..2700ee7ad86 100644 --- a/typedoc/functions/readFileSync.html +++ b/typedoc/functions/readFileSync.html @@ -3,4 +3,4 @@ present in the file's header.

    Parameters

    Returns string

    Promise which resolves with the content of the file

    -
    +
    diff --git a/typedoc/functions/reduceTo.html b/typedoc/functions/reduceTo.html index 2efa8dd3f36..4842f8a061b 100644 --- a/typedoc/functions/reduceTo.html +++ b/typedoc/functions/reduceTo.html @@ -4,4 +4,4 @@ checked as its type it's not guaranteed to match the passed type.

  • node: Node

    the Node to traverse

  • fqn: string[] = []

    the array with the qualifiers

    -
  • Returns estree.Node

    +

    Returns estree.Node

    diff --git a/typedoc/functions/reduceToIdentifier.html b/typedoc/functions/reduceToIdentifier.html index 08fb484eff6..496f074d222 100644 --- a/typedoc/functions/reduceToIdentifier.html +++ b/typedoc/functions/reduceToIdentifier.html @@ -2,4 +2,4 @@ filling in the FQN array with the accessed properties.

    Parameters

    Returns estree.Node

    +

    Returns estree.Node

    diff --git a/typedoc/functions/removeNodeWithLeadingWhitespaces.html b/typedoc/functions/removeNodeWithLeadingWhitespaces.html index c8a5970d22f..615a286835d 100644 --- a/typedoc/functions/removeNodeWithLeadingWhitespaces.html +++ b/typedoc/functions/removeNodeWithLeadingWhitespaces.html @@ -1 +1 @@ -removeNodeWithLeadingWhitespaces | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node
      • fixer: RuleFixer
      • OptionalremoveUntil: number

      Returns Fix

    +removeNodeWithLeadingWhitespaces | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node
      • fixer: RuleFixer
      • OptionalremoveUntil: number

      Returns Fix

    diff --git a/typedoc/functions/report.html b/typedoc/functions/report.html index 7b230be4254..f4876d879be 100644 --- a/typedoc/functions/report.html +++ b/typedoc/functions/report.html @@ -1,4 +1,4 @@ report | SonarJS linter helper functions
    • Wrapper for context.report, supporting secondary locations and cost. Encode those extra information in the issue message when rule is executed in Sonar* environment.

      -

      Parameters

      • context: RuleContext
      • reportDescriptor: ReportDescriptor
      • secondaryLocations: IssueLocation[] = []
      • Optionalcost: number

      Returns void

    +

    Parameters

    Returns void

    diff --git a/typedoc/functions/resolveAssignedValues.html b/typedoc/functions/resolveAssignedValues.html index 1a3b7ebd6d6..3325ad568a6 100644 --- a/typedoc/functions/resolveAssignedValues.html +++ b/typedoc/functions/resolveAssignedValues.html @@ -1 +1 @@ -resolveAssignedValues | SonarJS linter helper functions
    • Parameters

      • lhsVariable: Variable
      • writeExpr: null | Node
      • assignedValuesMap: Map<Variable, Values>
      • scope: Scope

      Returns Values

    +resolveAssignedValues | SonarJS linter helper functions
    • Parameters

      • lhsVariable: Variable
      • writeExpr: null | Node
      • assignedValuesMap: Map<Variable, Values>
      • scope: Scope

      Returns Values

    diff --git a/typedoc/functions/resolveFromFunctionReference.html b/typedoc/functions/resolveFromFunctionReference.html index 2fa7fe656f7..72903dcbf33 100644 --- a/typedoc/functions/resolveFromFunctionReference.html +++ b/typedoc/functions/resolveFromFunctionReference.html @@ -1 +1 @@ -resolveFromFunctionReference | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • functionIdentifier: Identifier

      Returns null | FunctionExpression | FunctionDeclaration

    +resolveFromFunctionReference | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • functionIdentifier: Identifier

      Returns null | FunctionExpression | FunctionDeclaration

    diff --git a/typedoc/functions/resolveFunction.html b/typedoc/functions/resolveFunction.html index 9d0c67e780f..4c4fc7dae59 100644 --- a/typedoc/functions/resolveFunction.html +++ b/typedoc/functions/resolveFunction.html @@ -1 +1 @@ -resolveFunction | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns estree.Function | null

    +resolveFunction | SonarJS linter helper functions
    • Parameters

      • context: RuleContext
      • node: Node

      Returns estree.Function | null

    diff --git a/typedoc/functions/resolveIdentifiers.html b/typedoc/functions/resolveIdentifiers.html index d80fe386c32..f8d23cdf186 100644 --- a/typedoc/functions/resolveIdentifiers.html +++ b/typedoc/functions/resolveIdentifiers.html @@ -1 +1 @@ -resolveIdentifiers | SonarJS linter helper functions
    • Parameters

      • node: Node
      • acceptShorthand: boolean = false

      Returns TSESTree.Identifier[]

    +resolveIdentifiers | SonarJS linter helper functions
    • Parameters

      • node: Node
      • acceptShorthand: boolean = false

      Returns TSESTree.Identifier[]

    diff --git a/typedoc/functions/searchFiles.html b/typedoc/functions/searchFiles.html index 884346a240c..67205377cd0 100644 --- a/typedoc/functions/searchFiles.html +++ b/typedoc/functions/searchFiles.html @@ -4,4 +4,4 @@

    Parameters

    Returns FilesByFilter

    +

    Returns FilesByFilter

    diff --git a/typedoc/functions/stripBOM.html b/typedoc/functions/stripBOM.html index 05d4ac12ab2..8430bf56d02 100644 --- a/typedoc/functions/stripBOM.html +++ b/typedoc/functions/stripBOM.html @@ -2,4 +2,4 @@

    A string's head is nothing else but its first character.

    Parameters

    Returns string

    the stripped string

    -
    +
    diff --git a/typedoc/functions/takeWithoutBreak.html b/typedoc/functions/takeWithoutBreak.html index d8294280d64..469859a8010 100644 --- a/typedoc/functions/takeWithoutBreak.html +++ b/typedoc/functions/takeWithoutBreak.html @@ -1,2 +1,2 @@ takeWithoutBreak | SonarJS linter helper functions
    • Excludes the break statement from the list

      -

      Parameters

      • nodes: Statement[]

      Returns Statement[]

    +

    Parameters

    Returns Statement[]

    diff --git a/typedoc/functions/toEncodedMessage.html b/typedoc/functions/toEncodedMessage.html index 916d62fe470..75e26dd52c9 100644 --- a/typedoc/functions/toEncodedMessage.html +++ b/typedoc/functions/toEncodedMessage.html @@ -9,4 +9,4 @@
  • OptionalsecondaryLocations: IssueLocation[]

    the secondary locations

  • Optionalcost: number

    the optional cost to fix

  • Returns Rule.ReportDescriptor

    the encoded message with secondary locations

    -
    +
    diff --git a/typedoc/functions/toSecondaryLocation.html b/typedoc/functions/toSecondaryLocation.html index 032b64b28eb..d645edb6489 100644 --- a/typedoc/functions/toSecondaryLocation.html +++ b/typedoc/functions/toSecondaryLocation.html @@ -1 +1 @@ -toSecondaryLocation | SonarJS linter helper functions
    +toSecondaryLocation | SonarJS linter helper functions
    diff --git a/typedoc/functions/toUnixPath.html b/typedoc/functions/toUnixPath.html index 366882d0d17..bd952875a29 100644 --- a/typedoc/functions/toUnixPath.html +++ b/typedoc/functions/toUnixPath.html @@ -1,4 +1,4 @@ toUnixPath | SonarJS linter helper functions
    • Converts a path to Unix format

      Parameters

      • path: string

        the path to convert

      Returns string

      the converted path

      -
    +
    diff --git a/typedoc/functions/tokenizeString.html b/typedoc/functions/tokenizeString.html index 2c32ed0880d..4db2d5bcf4a 100644 --- a/typedoc/functions/tokenizeString.html +++ b/typedoc/functions/tokenizeString.html @@ -1,4 +1,4 @@ tokenizeString | SonarJS linter helper functions
    +

    Parameters

    Returns StringLiteralToken[]

    diff --git a/typedoc/interfaces/EncodedMessage.html b/typedoc/interfaces/EncodedMessage.html index a4b38359625..0668e5c2833 100644 --- a/typedoc/interfaces/EncodedMessage.html +++ b/typedoc/interfaces/EncodedMessage.html @@ -1,4 +1,4 @@ -EncodedMessage | SonarJS linter helper functions
    interface EncodedMessage {
        cost?: number;
        message: string;
        secondaryLocations: IssueLocation[];
    }

    Properties

    cost? +EncodedMessage | SonarJS linter helper functions
    interface EncodedMessage {
        cost?: number;
        message: string;
        secondaryLocations: IssueLocation[];
    }

    Properties

    cost?: number
    message: string
    secondaryLocations: IssueLocation[]
    +

    Properties

    cost?: number
    message: string
    secondaryLocations: IssueLocation[]
    diff --git a/typedoc/interfaces/File.html b/typedoc/interfaces/File.html index 8ba9a55f872..006ebd526b1 100644 --- a/typedoc/interfaces/File.html +++ b/typedoc/interfaces/File.html @@ -1,3 +1,3 @@ -File | SonarJS linter helper functions
    interface File<T> {
        contents: T;
        filename: string;
    }

    Type Parameters

    • T

    Properties

    contents +File | SonarJS linter helper functions
    interface File<T> {
        contents: T;
        filename: string;
    }

    Type Parameters

    • T

    Properties

    Properties

    contents: T
    filename: string
    +

    Properties

    contents: T
    filename: string
    diff --git a/typedoc/interfaces/GroupReference.html b/typedoc/interfaces/GroupReference.html index 1d0176f89c9..358e00b5188 100644 --- a/typedoc/interfaces/GroupReference.html +++ b/typedoc/interfaces/GroupReference.html @@ -1,3 +1,3 @@ -GroupReference | SonarJS linter helper functions
    interface GroupReference {
        raw: string;
        value: string;
    }

    Properties

    raw +GroupReference | SonarJS linter helper functions
    interface GroupReference {
        raw: string;
        value: string;
    }

    Properties

    Properties

    raw: string
    value: string
    +

    Properties

    raw: string
    value: string
    diff --git a/typedoc/interfaces/IssueLocation.html b/typedoc/interfaces/IssueLocation.html index 029c6ef7637..5f1db71bf02 100644 --- a/typedoc/interfaces/IssueLocation.html +++ b/typedoc/interfaces/IssueLocation.html @@ -1,6 +1,6 @@ -IssueLocation | SonarJS linter helper functions
    interface IssueLocation {
        column: number;
        endColumn: number;
        endLine: number;
        line: number;
        message?: string;
    }

    Properties

    column +IssueLocation | SonarJS linter helper functions
    interface IssueLocation {
        column: number;
        endColumn: number;
        endLine: number;
        line: number;
        message?: string;
    }

    Properties

    column: number
    endColumn: number
    endLine: number
    line: number
    message?: string
    +

    Properties

    column: number
    endColumn: number
    endLine: number
    line: number
    message?: string
    diff --git a/typedoc/interfaces/Mocha.TestCase.html b/typedoc/interfaces/Mocha.TestCase.html index 464f12d2f59..4f9d87de860 100644 --- a/typedoc/interfaces/Mocha.TestCase.html +++ b/typedoc/interfaces/Mocha.TestCase.html @@ -1,3 +1,3 @@ -TestCase | SonarJS linter helper functions
    interface TestCase {
        callback: Function;
        node: Node;
    }

    Properties

    callback +TestCase | SonarJS linter helper functions
    interface TestCase {
        callback: Function;
        node: Node;
    }

    Properties

    Properties

    callback: Function
    node: Node
    +

    Properties

    callback: Function
    node: Node
    diff --git a/typedoc/interfaces/PolicyCheckerOptions.html b/typedoc/interfaces/PolicyCheckerOptions.html index 67051b3bbee..c901879b83b 100644 --- a/typedoc/interfaces/PolicyCheckerOptions.html +++ b/typedoc/interfaces/PolicyCheckerOptions.html @@ -1,6 +1,6 @@ -PolicyCheckerOptions | SonarJS linter helper functions
    interface PolicyCheckerOptions {
        actions: {
            anyValues?: string[];
            property: string;
        };
        conditions: {
            property: string;
        };
        effect: {
            allowValue: string;
            property: string;
            type: "string" | "FullyQualifiedName";
        };
        principals: {
            anyValues?: string[];
            property: string;
            type: "FullyQualifiedName" | "json";
        };
        resources: {
            property: string;
        };
    }

    Properties

    actions +PolicyCheckerOptions | SonarJS linter helper functions
    interface PolicyCheckerOptions {
        actions: {
            anyValues?: string[];
            property: string;
        };
        conditions: {
            property: string;
        };
        effect: {
            allowValue: string;
            property: string;
            type: "string" | "FullyQualifiedName";
        };
        principals: {
            anyValues?: string[];
            property: string;
            type: "FullyQualifiedName" | "json";
        };
        resources: {
            property: string;
        };
    }

    Properties

    actions: {
        anyValues?: string[];
        property: string;
    }
    conditions: {
        property: string;
    }
    effect: {
        allowValue: string;
        property: string;
        type: "string" | "FullyQualifiedName";
    }
    principals: {
        anyValues?: string[];
        property: string;
        type: "FullyQualifiedName" | "json";
    }
    resources: {
        property: string;
    }
    +

    Properties

    actions: {
        anyValues?: string[];
        property: string;
    }
    conditions: {
        property: string;
    }
    effect: {
        allowValue: string;
        property: string;
        type: "string" | "FullyQualifiedName";
    }
    principals: {
        anyValues?: string[];
        property: string;
        type: "FullyQualifiedName" | "json";
    }
    resources: {
        property: string;
    }
    diff --git a/typedoc/interfaces/ReferenceLike.html b/typedoc/interfaces/ReferenceLike.html index 3bcfd21b038..5087a94fc32 100644 --- a/typedoc/interfaces/ReferenceLike.html +++ b/typedoc/interfaces/ReferenceLike.html @@ -1,4 +1,4 @@ -ReferenceLike | SonarJS linter helper functions
    interface ReferenceLike {
        from: Scope;
        identifier: JSXIdentifier | Identifier;
        init: boolean;
        resolved: null | Variable;
        writeExpr: null | Node;
        isRead(): boolean;
        isReadOnly(): boolean;
        isReadWrite(): boolean;
        isWrite(): boolean;
        isWriteOnly(): boolean;
    }

    Properties

    from +ReferenceLike | SonarJS linter helper functions
    interface ReferenceLike {
        from: Scope;
        identifier: JSXIdentifier | Identifier;
        init: boolean;
        resolved: null | Variable;
        writeExpr: null | Node;
        isRead(): boolean;
        isReadOnly(): boolean;
        isReadWrite(): boolean;
        isWrite(): boolean;
        isWriteOnly(): boolean;
    }

    Properties

    from: Scope
    identifier: JSXIdentifier | Identifier
    init: boolean
    resolved: null | Variable
    writeExpr: null | Node

    Methods

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    +

    Properties

    from: Scope
    identifier: JSXIdentifier | Identifier
    init: boolean
    resolved: null | Variable
    writeExpr: null | Node

    Methods

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    diff --git a/typedoc/interfaces/StringLiteralToken.html b/typedoc/interfaces/StringLiteralToken.html index feb8bcbd94e..86f5eeb4552 100644 --- a/typedoc/interfaces/StringLiteralToken.html +++ b/typedoc/interfaces/StringLiteralToken.html @@ -1,3 +1,3 @@ -StringLiteralToken | SonarJS linter helper functions
    interface StringLiteralToken {
        range: [number, number];
        value: string;
    }

    Properties

    range +StringLiteralToken | SonarJS linter helper functions
    interface StringLiteralToken {
        range: [number, number];
        value: string;
    }

    Properties

    Properties

    range: [number, number]
    value: string
    +

    Properties

    range: [number, number]
    value: string
    diff --git a/typedoc/modules/Chai.html b/typedoc/modules/Chai.html index 1bf1c0f30a3..0881d9bc6b7 100644 --- a/typedoc/modules/Chai.html +++ b/typedoc/modules/Chai.html @@ -1,3 +1,3 @@ -Chai | SonarJS linter helper functions

    Index

    Functions

    isAssertion +Chai | SonarJS linter helper functions
    diff --git a/typedoc/modules/Express.html b/typedoc/modules/Express.html index 8fea032a398..888a819fd43 100644 --- a/typedoc/modules/Express.html +++ b/typedoc/modules/Express.html @@ -1,5 +1,5 @@ Express | SonarJS linter helper functions

    This modules provides utilities for writing rules about Express.js.

    -

    Index

    Functions

    Index

    Functions

    attemptFindAppInjection attemptFindAppInstantiation isMiddlewareInstance isUsingMiddleware diff --git a/typedoc/modules/Mocha.html b/typedoc/modules/Mocha.html index 0b3a99928c2..0e610b2f013 100644 --- a/typedoc/modules/Mocha.html +++ b/typedoc/modules/Mocha.html @@ -1,4 +1,4 @@ -Mocha | SonarJS linter helper functions

    Index

    Interfaces

    TestCase +Mocha | SonarJS linter helper functions

    Index

    Interfaces

    Functions

    extractTestCase isDescribeCase isTestCase diff --git a/typedoc/modules/Sinon.html b/typedoc/modules/Sinon.html index cc8d653430f..9f1327bab31 100644 --- a/typedoc/modules/Sinon.html +++ b/typedoc/modules/Sinon.html @@ -1,3 +1,3 @@ -Sinon | SonarJS linter helper functions

    Index

    Functions

    isAssertion +Sinon | SonarJS linter helper functions
    diff --git a/typedoc/modules/Vitest.html b/typedoc/modules/Vitest.html index d8a51f05fd7..80b5fb75de8 100644 --- a/typedoc/modules/Vitest.html +++ b/typedoc/modules/Vitest.html @@ -1,3 +1,3 @@ -Vitest | SonarJS linter helper functions

    Index

    Functions

    isAssertion +Vitest | SonarJS linter helper functions
    diff --git a/typedoc/types/Alternation.html b/typedoc/types/Alternation.html index 27b86dceef3..37bc60fc6b3 100644 --- a/typedoc/types/Alternation.html +++ b/typedoc/types/Alternation.html @@ -1,2 +1,2 @@ Alternation | SonarJS linter helper functions
    Alternation:
        | Pattern
        | CapturingGroup
        | Group
        | LookaroundAssertion

    An alternation is a regexpp node that has an alternatives field.

    -
    +
    diff --git a/typedoc/types/AwsCdkCallback.html b/typedoc/types/AwsCdkCallback.html index 9298868cb10..7969dc22dcb 100644 --- a/typedoc/types/AwsCdkCallback.html +++ b/typedoc/types/AwsCdkCallback.html @@ -1 +1 @@ -AwsCdkCallback | SonarJS linter helper functions
    AwsCdkCallback: {
        functionName?: string;
        methods?: string[];
        callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void;
        newExpression?(expr: NewExpression, ctx: RuleContext): void;
    }
    +AwsCdkCallback | SonarJS linter helper functions
    AwsCdkCallback: {
        functionName?: string;
        methods?: string[];
        callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void;
        newExpression?(expr: NewExpression, ctx: RuleContext): void;
    }
    diff --git a/typedoc/types/AwsCdkConsumer.html b/typedoc/types/AwsCdkConsumer.html index 33e7b1c1f0e..0212d04c02c 100644 --- a/typedoc/types/AwsCdkConsumer.html +++ b/typedoc/types/AwsCdkConsumer.html @@ -1 +1 @@ -AwsCdkConsumer | SonarJS linter helper functions
    AwsCdkConsumer: ((expr: estree.NewExpression, ctx: Rule.RuleContext) => void) | AwsCdkCallback
    +AwsCdkConsumer | SonarJS linter helper functions
    AwsCdkConsumer: ((expr: estree.NewExpression, ctx: Rule.RuleContext) => void) | AwsCdkCallback
    diff --git a/typedoc/types/AwsCdkConsumerMap.html b/typedoc/types/AwsCdkConsumerMap.html index a5dd8981501..8854887f53f 100644 --- a/typedoc/types/AwsCdkConsumerMap.html +++ b/typedoc/types/AwsCdkConsumerMap.html @@ -1 +1 @@ -AwsCdkConsumerMap | SonarJS linter helper functions
    AwsCdkConsumerMap: {
        [key: FullyQualifiedName]: AwsCdkConsumer;
    }
    +AwsCdkConsumerMap | SonarJS linter helper functions
    AwsCdkConsumerMap: {
        [key: FullyQualifiedName]: AwsCdkConsumer;
    }
    diff --git a/typedoc/types/ContextOverrider.html b/typedoc/types/ContextOverrider.html index 201e93eabdd..cad02e25de2 100644 --- a/typedoc/types/ContextOverrider.html +++ b/typedoc/types/ContextOverrider.html @@ -1 +1 @@ -ContextOverrider | SonarJS linter helper functions
    ContextOverrider: ((context: Rule.RuleContext, onReport: ReportOverrider) => Rule.RuleContext)
    +ContextOverrider | SonarJS linter helper functions
    ContextOverrider: ((context: Rule.RuleContext, onReport: ReportOverrider) => Rule.RuleContext)
    diff --git a/typedoc/types/FullyQualifiedName.html b/typedoc/types/FullyQualifiedName.html index 4236e99f501..29c33f598b3 100644 --- a/typedoc/types/FullyQualifiedName.html +++ b/typedoc/types/FullyQualifiedName.html @@ -1,2 +1,2 @@ FullyQualifiedName | SonarJS linter helper functions
    FullyQualifiedName: string

    A symbol fully qualified name, e.g. aws-cdk-lib.aws_sns.Topic.

    -
    +
    diff --git a/typedoc/types/FunctionNodeType.html b/typedoc/types/FunctionNodeType.html index 9e5a42e8b1d..b2d26e7ced1 100644 --- a/typedoc/types/FunctionNodeType.html +++ b/typedoc/types/FunctionNodeType.html @@ -1 +1 @@ -FunctionNodeType | SonarJS linter helper functions
    FunctionNodeType: estree.FunctionDeclaration | estree.FunctionExpression | estree.ArrowFunctionExpression
    +FunctionNodeType | SonarJS linter helper functions
    FunctionNodeType: estree.FunctionDeclaration | estree.FunctionExpression | estree.ArrowFunctionExpression
    diff --git a/typedoc/types/LocationHolder.html b/typedoc/types/LocationHolder.html index 24e29e889fd..90178fe6ecf 100644 --- a/typedoc/types/LocationHolder.html +++ b/typedoc/types/LocationHolder.html @@ -1 +1 @@ -LocationHolder | SonarJS linter helper functions
    LocationHolder:
        | AST.Token
        | TSESTree.Node
        | estree.Node
        | {
            loc: AST.SourceLocation;
        }
    +LocationHolder | SonarJS linter helper functions
    LocationHolder:
        | AST.Token
        | TSESTree.Node
        | estree.Node
        | {
            loc: AST.SourceLocation;
        }
    diff --git a/typedoc/types/LoopLike.html b/typedoc/types/LoopLike.html index 61c0bf2b57f..5dd701001fe 100644 --- a/typedoc/types/LoopLike.html +++ b/typedoc/types/LoopLike.html @@ -1 +1 @@ -LoopLike | SonarJS linter helper functions
    LoopLike:
        | estree.WhileStatement
        | estree.DoWhileStatement
        | estree.ForStatement
        | estree.ForOfStatement
        | estree.ForInStatement
    +LoopLike | SonarJS linter helper functions
    LoopLike:
        | estree.WhileStatement
        | estree.DoWhileStatement
        | estree.ForStatement
        | estree.ForOfStatement
        | estree.ForInStatement
    diff --git a/typedoc/types/Node.html b/typedoc/types/Node.html index d6ce96a597c..2c7d381e210 100644 --- a/typedoc/types/Node.html +++ b/typedoc/types/Node.html @@ -1 +1 @@ -Node | SonarJS linter helper functions
    Node: estree.Node | TSESTree.Node
    +Node | SonarJS linter helper functions
    Node: estree.Node | TSESTree.Node
    diff --git a/typedoc/types/RegexRuleContext.html b/typedoc/types/RegexRuleContext.html index ada88606929..cd8845db6ba 100644 --- a/typedoc/types/RegexRuleContext.html +++ b/typedoc/types/RegexRuleContext.html @@ -1,3 +1,3 @@ RegexRuleContext | SonarJS linter helper functions
    RegexRuleContext: Rule.RuleContext & {
        node: estree.Node;
        reportRegExpNode: ((descriptor: RegexReportDescriptor, secondaryLocations?: IssueLocation[]) => void);
    }

    Rule context for regex rules that also includes the original ESLint node denoting the regular expression (string) literal.

    -
    +
    diff --git a/typedoc/types/ReportOverrider.html b/typedoc/types/ReportOverrider.html index c461b6103e2..648a05966ec 100644 --- a/typedoc/types/ReportOverrider.html +++ b/typedoc/types/ReportOverrider.html @@ -1 +1 @@ -ReportOverrider | SonarJS linter helper functions
    ReportOverrider: ((context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor) => void)
    +ReportOverrider | SonarJS linter helper functions
    ReportOverrider: ((context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor) => void)
    diff --git a/typedoc/types/RequiredParserServices.html b/typedoc/types/RequiredParserServices.html index da44e9afcf2..45c4e21c4da 100644 --- a/typedoc/types/RequiredParserServices.html +++ b/typedoc/types/RequiredParserServices.html @@ -1 +1 @@ -RequiredParserServices | SonarJS linter helper functions
    RequiredParserServices: ParserServicesWithTypeInformation
    +RequiredParserServices | SonarJS linter helper functions
    RequiredParserServices: ParserServicesWithTypeInformation
    diff --git a/typedoc/types/RuleContext.html b/typedoc/types/RuleContext.html index 4fc8aa9724d..f31350f10ca 100644 --- a/typedoc/types/RuleContext.html +++ b/typedoc/types/RuleContext.html @@ -1 +1 @@ -RuleContext | SonarJS linter helper functions
    RuleContext: TSESLint.RuleContext<string, string[]>
    +RuleContext | SonarJS linter helper functions
    RuleContext: TSESLint.RuleContext<string, string[]>
    diff --git a/typedoc/types/StringLiteral.html b/typedoc/types/StringLiteral.html index 5f993717e46..9949b471416 100644 --- a/typedoc/types/StringLiteral.html +++ b/typedoc/types/StringLiteral.html @@ -1 +1 @@ -StringLiteral | SonarJS linter helper functions
    StringLiteral: estree.Literal & {
        value: string;
    }
    +StringLiteral | SonarJS linter helper functions
    StringLiteral: estree.Literal & {
        value: string;
    }
    diff --git a/typedoc/types/Values.html b/typedoc/types/Values.html index 107f8089a5a..e10738af9c9 100644 --- a/typedoc/types/Values.html +++ b/typedoc/types/Values.html @@ -1 +1 @@ -Values | SonarJS linter helper functions
    Values: AssignedValues | UnknownValue
    +Values | SonarJS linter helper functions
    Values: AssignedValues | UnknownValue
    diff --git a/typedoc/variables/FUNCTION_NODES.html b/typedoc/variables/FUNCTION_NODES.html index 39457320e00..d131b86345e 100644 --- a/typedoc/variables/FUNCTION_NODES.html +++ b/typedoc/variables/FUNCTION_NODES.html @@ -1 +1 @@ -FUNCTION_NODES | SonarJS linter helper functions
    FUNCTION_NODES: string[] = ...
    +FUNCTION_NODES | SonarJS linter helper functions
    FUNCTION_NODES: string[] = ...
    diff --git a/typedoc/variables/PACKAGE_JSON.html b/typedoc/variables/PACKAGE_JSON.html index d9fd776c6c0..fe6b2764969 100644 --- a/typedoc/variables/PACKAGE_JSON.html +++ b/typedoc/variables/PACKAGE_JSON.html @@ -1 +1 @@ -PACKAGE_JSON | SonarJS linter helper functions
    PACKAGE_JSON: "package.json" = 'package.json'
    +PACKAGE_JSON | SonarJS linter helper functions
    PACKAGE_JSON: "package.json" = 'package.json'
    diff --git a/typedoc/variables/SONAR_RUNTIME.html b/typedoc/variables/SONAR_RUNTIME.html index 64c11bef021..4ca84ac0073 100644 --- a/typedoc/variables/SONAR_RUNTIME.html +++ b/typedoc/variables/SONAR_RUNTIME.html @@ -1 +1 @@ -SONAR_RUNTIME | SonarJS linter helper functions
    SONAR_RUNTIME: "sonar-runtime" = 'sonar-runtime'
    +SONAR_RUNTIME | SonarJS linter helper functions
    SONAR_RUNTIME: "sonar-runtime" = 'sonar-runtime'
    diff --git a/typedoc/variables/TYPED_ARRAY_TYPES.html b/typedoc/variables/TYPED_ARRAY_TYPES.html index aa43f730b61..6b721a42150 100644 --- a/typedoc/variables/TYPED_ARRAY_TYPES.html +++ b/typedoc/variables/TYPED_ARRAY_TYPES.html @@ -1,3 +1,3 @@ TYPED_ARRAY_TYPES | SonarJS linter helper functions
    TYPED_ARRAY_TYPES: string[] = ...
    +
    diff --git a/typedoc/variables/UTILITY_TYPES.html b/typedoc/variables/UTILITY_TYPES.html index 9d46aea5ce3..5a5c97fd1f1 100644 --- a/typedoc/variables/UTILITY_TYPES.html +++ b/typedoc/variables/UTILITY_TYPES.html @@ -1,3 +1,3 @@ UTILITY_TYPES | SonarJS linter helper functions
    UTILITY_TYPES: Set<string> = ...

    TypeScript provides a set of utility types to facilitate type transformations.

    +
    diff --git a/typedoc/variables/collectionConstructor.html b/typedoc/variables/collectionConstructor.html index 7fbfc3c70aa..0224c8d8c94 100644 --- a/typedoc/variables/collectionConstructor.html +++ b/typedoc/variables/collectionConstructor.html @@ -1 +1 @@ -collectionConstructor | SonarJS linter helper functions

    Variable collectionConstructorConst

    collectionConstructor: string[] = ...
    +collectionConstructor | SonarJS linter helper functions

    Variable collectionConstructorConst

    collectionConstructor: string[] = ...
    diff --git a/typedoc/variables/copyingSortLike.html b/typedoc/variables/copyingSortLike.html index eab0134e64f..339709fc55a 100644 --- a/typedoc/variables/copyingSortLike.html +++ b/typedoc/variables/copyingSortLike.html @@ -1 +1 @@ -copyingSortLike | SonarJS linter helper functions
    copyingSortLike: string[] = ...
    +copyingSortLike | SonarJS linter helper functions
    copyingSortLike: string[] = ...
    diff --git a/typedoc/variables/detectReactRule.html b/typedoc/variables/detectReactRule.html index a79773ba697..9e11a54b8b2 100644 --- a/typedoc/variables/detectReactRule.html +++ b/typedoc/variables/detectReactRule.html @@ -1 +1 @@ -detectReactRule | SonarJS linter helper functions
    detectReactRule: Rule.RuleModule = ...
    +detectReactRule | SonarJS linter helper functions
    detectReactRule: Rule.RuleModule = ...
    diff --git a/typedoc/variables/functionLike.html b/typedoc/variables/functionLike.html index 02edae809a6..d2ab415d633 100644 --- a/typedoc/variables/functionLike.html +++ b/typedoc/variables/functionLike.html @@ -1 +1 @@ -functionLike | SonarJS linter helper functions
    functionLike: Set<string> = ...
    +functionLike | SonarJS linter helper functions
    functionLike: Set<string> = ...
    diff --git a/typedoc/variables/globalsByLibraries.html b/typedoc/variables/globalsByLibraries.html index 807639a09be..eebcd89d121 100644 --- a/typedoc/variables/globalsByLibraries.html +++ b/typedoc/variables/globalsByLibraries.html @@ -1 +1 @@ -globalsByLibraries | SonarJS linter helper functions
    globalsByLibraries: {
        amd: string[];
        applescript: string[];
        atomtest: string[];
        browser: string[];
        builtin: string[];
        commonjs: string[];
        couch: string[];
        embertest: string[];
        flow: string[];
        greasemonkey: string[];
        jasmine: string[];
        jest: string[];
        jquery: string[];
        meteor: string[];
        mocha: string[];
        mongo: string[];
        nashorn: string[];
        node: string[];
        phantomjs: string[];
        prototypejs: string[];
        protractor: string[];
        qunit: string[];
        rhino: string[];
        serviceworker: string[];
        shared-node-browser: string[];
        shelljs: string[];
        webextensions: string[];
        worker: string[];
        wsh: string[];
        yui: string[];
    } = ...
    +globalsByLibraries | SonarJS linter helper functions
    globalsByLibraries: {
        amd: string[];
        applescript: string[];
        atomtest: string[];
        browser: string[];
        builtin: string[];
        commonjs: string[];
        couch: string[];
        embertest: string[];
        flow: string[];
        greasemonkey: string[];
        jasmine: string[];
        jest: string[];
        jquery: string[];
        meteor: string[];
        mocha: string[];
        mongo: string[];
        nashorn: string[];
        node: string[];
        phantomjs: string[];
        prototypejs: string[];
        protractor: string[];
        qunit: string[];
        rhino: string[];
        serviceworker: string[];
        shared-node-browser: string[];
        shelljs: string[];
        webextensions: string[];
        worker: string[];
        wsh: string[];
        yui: string[];
    } = ...
    diff --git a/typedoc/variables/sortLike.html b/typedoc/variables/sortLike.html index 01451408470..d225809172d 100644 --- a/typedoc/variables/sortLike.html +++ b/typedoc/variables/sortLike.html @@ -1 +1 @@ -sortLike | SonarJS linter helper functions
    sortLike: string[] = ...
    +sortLike | SonarJS linter helper functions
    sortLike: string[] = ...
    diff --git a/typedoc/variables/unknownValue.html b/typedoc/variables/unknownValue.html index 789205f82b1..e31f7185bc4 100644 --- a/typedoc/variables/unknownValue.html +++ b/typedoc/variables/unknownValue.html @@ -1 +1 @@ -unknownValue | SonarJS linter helper functions
    unknownValue: UnknownValue = ...
    +unknownValue | SonarJS linter helper functions
    unknownValue: UnknownValue = ...
    diff --git a/typedoc/variables/writingMethods.html b/typedoc/variables/writingMethods.html index 078eb1d7a47..3009d8d41e2 100644 --- a/typedoc/variables/writingMethods.html +++ b/typedoc/variables/writingMethods.html @@ -1 +1 @@ -writingMethods | SonarJS linter helper functions
    writingMethods: string[] = ...
    +writingMethods | SonarJS linter helper functions
    writingMethods: string[] = ...