diff --git a/typedoc/classes/LiveVariables.html b/typedoc/classes/LiveVariables.html index 525e82bac16..333f212f2af 100644 --- a/typedoc/classes/LiveVariables.html +++ b/typedoc/classes/LiveVariables.html @@ -1,4 +1,4 @@ -LiveVariables | SonarJS linter helper functions

Class LiveVariables

Constructors

constructor +LiveVariables | SonarJS linter helper functions

Class LiveVariables

Constructors

constructor

Properties

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

Methods

add propagate -

Constructors

constructor

Properties

gen

gen: Set<Variable> = ...

variables that are being read in the block

-

in

in: Set<Variable> = ...

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

-

kill

kill: Set<Variable> = ...

variables that are being written in the block

-

out

out: Variable[] = []

variables needed by successors

-

references

references: Set<ReferenceLike> = ...

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

-

segment

segment: CodePathSegment

Methods

add

propagate

  • propagate(liveVariablesMap): boolean

  • Parameters

    Returns boolean

Settings

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

gen

gen: Set<Variable> = ...

variables that are being read in the block

+

in

in: Set<Variable> = ...

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

+

kill

kill: Set<Variable> = ...

variables that are being written in the block

+

out

out: Variable[] = []

variables needed by successors

+

references

references: Set<ReferenceLike> = ...

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

+

segment

segment: CodePathSegment

Methods

add

propagate

  • propagate(liveVariablesMap): boolean

  • Parameters

    Returns boolean

Settings

On This Page

Constructors
Properties
Methods
diff --git a/typedoc/classes/ReachingDefinitions.html b/typedoc/classes/ReachingDefinitions.html index e106ea1ca9b..0a2530ddf2a 100644 --- a/typedoc/classes/ReachingDefinitions.html +++ b/typedoc/classes/ReachingDefinitions.html @@ -1,4 +1,4 @@ -ReachingDefinitions | SonarJS linter helper functions

Class ReachingDefinitions

Constructors

constructor +ReachingDefinitions | SonarJS linter helper functions

Class ReachingDefinitions

Constructors

constructor

Properties

in out references @@ -7,5 +7,5 @@ join propagate updateProgramState -

Constructors

constructor

Properties

in

in: Map<Variable, Values> = ...

out

out: Map<Variable, Values> = ...

references

references: Set<Reference> = ...

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

-

segment

segment: CodePathSegment

Methods

add

join

propagate

updateProgramState

Settings

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

in

in: Map<Variable, Values> = ...

out

out: Map<Variable, Values> = ...

references

references: Set<Reference> = ...

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

+

segment

segment: CodePathSegment

Methods

add

join

propagate

updateProgramState

Settings

On This Page

Constructors
Properties
Methods
diff --git a/typedoc/functions/AwsCdkCheckArguments.html b/typedoc/functions/AwsCdkCheckArguments.html index 4c413e7e675..f7282768d83 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)

    Settings

    +

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

    Settings

    diff --git a/typedoc/functions/AwsCdkTemplate.html b/typedoc/functions/AwsCdkTemplate.html index 1526a345cd2..151a28fca0a 100644 --- a/typedoc/functions/AwsCdkTemplate.html +++ b/typedoc/functions/AwsCdkTemplate.html @@ -2,4 +2,4 @@

    Parameters

    Returns Rule.RuleModule

    the instantiated rule module

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/AwsIamPolicyTemplate.html b/typedoc/functions/AwsIamPolicyTemplate.html index 71358e67a5e..e84b51ea7e7 100644 --- a/typedoc/functions/AwsIamPolicyTemplate.html +++ b/typedoc/functions/AwsIamPolicyTemplate.html @@ -1 +1 @@ -AwsIamPolicyTemplate | SonarJS linter helper functions

    Function AwsIamPolicyTemplate

    • AwsIamPolicyTemplate(statementChecker, meta): RuleModule

    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    Settings

    +AwsIamPolicyTemplate | SonarJS linter helper functions

    Function AwsIamPolicyTemplate

    • AwsIamPolicyTemplate(statementChecker, meta): RuleModule

    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    Settings

    diff --git a/typedoc/functions/Chai.isAssertion.html b/typedoc/functions/Chai.isAssertion.html index 61da226f918..2e81a7e1d91 100644 --- a/typedoc/functions/Chai.isAssertion.html +++ b/typedoc/functions/Chai.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Chai.isImported.html b/typedoc/functions/Chai.isImported.html index fc3ca9c576d..9ffac9f8c9f 100644 --- a/typedoc/functions/Chai.isImported.html +++ b/typedoc/functions/Chai.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html b/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html index 2a40bc7ddc4..3c9789fed8a 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/Express.attemptFindAppInjection.html b/typedoc/functions/Express.attemptFindAppInjection.html index f46fea7bcfb..28d5374e807 100644 --- a/typedoc/functions/Express.attemptFindAppInjection.html +++ b/typedoc/functions/Express.attemptFindAppInjection.html @@ -1,3 +1,3 @@ attemptFindAppInjection | SonarJS linter helper functions

    Function attemptFindAppInjection

    • attemptFindAppInjection(functionDef, context, node): estree.Identifier | undefined

    • 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

    Settings

    +

    Parameters

    Returns estree.Identifier | undefined

    Settings

    diff --git a/typedoc/functions/Express.attemptFindAppInstantiation.html b/typedoc/functions/Express.attemptFindAppInstantiation.html index a8331ed7eca..7be252a9dba 100644 --- a/typedoc/functions/Express.attemptFindAppInstantiation.html +++ b/typedoc/functions/Express.attemptFindAppInstantiation.html @@ -1,3 +1,3 @@ attemptFindAppInstantiation | SonarJS linter helper functions

    Function attemptFindAppInstantiation

    • attemptFindAppInstantiation(varDecl, context): estree.Identifier | undefined

    • Checks whether the declaration looks somewhat like <id> = express() and returns <id> if it matches.

      -

      Parameters

      • varDecl: VariableDeclarator
      • context: RuleContext

      Returns estree.Identifier | undefined

    Settings

    +

    Parameters

    Returns estree.Identifier | undefined

    Settings

    diff --git a/typedoc/functions/Express.isMiddlewareInstance.html b/typedoc/functions/Express.isMiddlewareInstance.html index ff7d0cf3f5e..866a0c97131 100644 --- a/typedoc/functions/Express.isMiddlewareInstance.html +++ b/typedoc/functions/Express.isMiddlewareInstance.html @@ -1,3 +1,3 @@ isMiddlewareInstance | SonarJS linter helper functions

    Function isMiddlewareInstance

    • isMiddlewareInstance(context, middlewares, n): boolean

    • 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/Express.isUsingMiddleware.html b/typedoc/functions/Express.isUsingMiddleware.html index 76f0ad11d24..bec01bb7b61 100644 --- a/typedoc/functions/Express.isUsingMiddleware.html +++ b/typedoc/functions/Express.isUsingMiddleware.html @@ -1,3 +1,3 @@ isUsingMiddleware | SonarJS linter helper functions

    Function isUsingMiddleware

    • isUsingMiddleware(context, callExpression, app, middlewareNodePredicate): boolean

    • 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/Mocha.extractTestCase.html b/typedoc/functions/Mocha.extractTestCase.html index 476b2487dca..c9510e722e0 100644 --- a/typedoc/functions/Mocha.extractTestCase.html +++ b/typedoc/functions/Mocha.extractTestCase.html @@ -1 +1 @@ -extractTestCase | SonarJS linter helper functions

    Function extractTestCase

    Settings

    +extractTestCase | SonarJS linter helper functions

    Function extractTestCase

    Settings

    diff --git a/typedoc/functions/Mocha.isDescribeCase.html b/typedoc/functions/Mocha.isDescribeCase.html index 55827d1cba8..15e8091d60d 100644 --- a/typedoc/functions/Mocha.isDescribeCase.html +++ b/typedoc/functions/Mocha.isDescribeCase.html @@ -1,2 +1,2 @@ isDescribeCase | SonarJS linter helper functions

    Function isDescribeCase

    • isDescribeCase(node): boolean

    • returns true if the node is a describe block

      -

      Parameters

      • node: Node

      Returns boolean

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/Mocha.isTestCase.html b/typedoc/functions/Mocha.isTestCase.html index f8678bd6edf..6217a8505ad 100644 --- a/typedoc/functions/Mocha.isTestCase.html +++ b/typedoc/functions/Mocha.isTestCase.html @@ -1,2 +1,2 @@ isTestCase | SonarJS linter helper functions

    Function isTestCase

    • isTestCase(node): boolean

    • returns true if the node is a test case

      -

      Parameters

      • node: Node

      Returns boolean

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/Mocha.isTestConstruct.html b/typedoc/functions/Mocha.isTestConstruct.html index 404404f0b62..fd321e5cb32 100644 --- a/typedoc/functions/Mocha.isTestConstruct.html +++ b/typedoc/functions/Mocha.isTestConstruct.html @@ -1 +1 @@ -isTestConstruct | SonarJS linter helper functions

    Function isTestConstruct

    • isTestConstruct(node, constructs?): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isTestConstruct | SonarJS linter helper functions

    Function isTestConstruct

    • isTestConstruct(node, constructs?): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/S3BucketTemplate.html b/typedoc/functions/S3BucketTemplate.html index 91365621559..c8d7d1325ba 100644 --- a/typedoc/functions/S3BucketTemplate.html +++ b/typedoc/functions/S3BucketTemplate.html @@ -5,4 +5,4 @@

    Parameters

    Returns Rule.RuleModule

    the instantiated rule definition

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/Sinon.isAssertion.html b/typedoc/functions/Sinon.isAssertion.html index 9db9bb3939f..6609fd397cf 100644 --- a/typedoc/functions/Sinon.isAssertion.html +++ b/typedoc/functions/Sinon.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Sinon.isImported.html b/typedoc/functions/Sinon.isImported.html index b7a418735bb..ec51c1e164a 100644 --- a/typedoc/functions/Sinon.isImported.html +++ b/typedoc/functions/Sinon.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Vitest.isAssertion.html b/typedoc/functions/Vitest.isAssertion.html index 824197eff43..33c9205c536 100644 --- a/typedoc/functions/Vitest.isAssertion.html +++ b/typedoc/functions/Vitest.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Vitest.isImported.html b/typedoc/functions/Vitest.isImported.html index 6c1de0423d4..bcbbb494dd3 100644 --- a/typedoc/functions/Vitest.isImported.html +++ b/typedoc/functions/Vitest.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/ancestorsChain.html b/typedoc/functions/ancestorsChain.html index e692d7848ee..fc00cc90e8f 100644 --- a/typedoc/functions/ancestorsChain.html +++ b/typedoc/functions/ancestorsChain.html @@ -1 +1 @@ -ancestorsChain | SonarJS linter helper functions

    Function ancestorsChain

    • ancestorsChain(node, boundaryTypes): Node[]

    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    Settings

    +ancestorsChain | SonarJS linter helper functions

    Function ancestorsChain

    • ancestorsChain(node, boundaryTypes): Node[]

    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    Settings

    diff --git a/typedoc/functions/areEquivalent.html b/typedoc/functions/areEquivalent.html index bd31827d7f2..f4c5fe1b451 100644 --- a/typedoc/functions/areEquivalent.html +++ b/typedoc/functions/areEquivalent.html @@ -1,4 +1,4 @@ areEquivalent | SonarJS linter helper functions

    Function areEquivalent

    • areEquivalent(first, second, sourceCode): boolean

    • 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/checkSensitiveCall.html b/typedoc/functions/checkSensitiveCall.html index 6c0e92465d7..a8d4c19c196 100644 --- a/typedoc/functions/checkSensitiveCall.html +++ b/typedoc/functions/checkSensitiveCall.html @@ -1 +1 @@ -checkSensitiveCall | SonarJS linter helper functions

    Function checkSensitiveCall

    • checkSensitiveCall(context, callExpression, sensitiveArgumentIndex, sensitiveProperty, sensitivePropertyValue, message): void

    • Parameters

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

      Returns void

    Settings

    +checkSensitiveCall | SonarJS linter helper functions

    Function checkSensitiveCall

    • checkSensitiveCall(context, callExpression, sensitiveArgumentIndex, sensitiveProperty, sensitivePropertyValue, message): void

    • Parameters

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

      Returns void

    Settings

    diff --git a/typedoc/functions/childrenOf.html b/typedoc/functions/childrenOf.html index 3f6d1e97abc..7a2d5a41898 100644 --- a/typedoc/functions/childrenOf.html +++ b/typedoc/functions/childrenOf.html @@ -2,4 +2,4 @@

    Parameters

    Returns estree.Node[]

    the node children

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/collectIfBranches.html b/typedoc/functions/collectIfBranches.html index 37527246733..c597830660f 100644 --- a/typedoc/functions/collectIfBranches.html +++ b/typedoc/functions/collectIfBranches.html @@ -1,2 +1,2 @@ collectIfBranches | SonarJS linter helper functions

    Function collectIfBranches

    • collectIfBranches(node): {
          branches: Statement[];
          endsWithElse: boolean;
      }

    • 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

    Settings

    +

    Parameters

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

    Settings

    diff --git a/typedoc/functions/collectSwitchBranches.html b/typedoc/functions/collectSwitchBranches.html index 1bddbc43fe0..80f0a09c9f1 100644 --- a/typedoc/functions/collectSwitchBranches.html +++ b/typedoc/functions/collectSwitchBranches.html @@ -1,2 +1,2 @@ collectSwitchBranches | SonarJS linter helper functions

    Function collectSwitchBranches

    • collectSwitchBranches(node): {
          branches: Statement[][];
          endsWithDefault: boolean;
      }

    • Returns a list of switch clauses (both case and default)

      -

      Parameters

      • node: SwitchStatement

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

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

    Settings

    +

    Parameters

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

    Settings

    diff --git a/typedoc/functions/encodeContents.html b/typedoc/functions/encodeContents.html index cc17090df3b..32a7e8321c8 100644 --- a/typedoc/functions/encodeContents.html +++ b/typedoc/functions/encodeContents.html @@ -1 +1 @@ -encodeContents | SonarJS linter helper functions

    Function encodeContents

    • encodeContents(message, secondaryLocations?, cost?): string

    • Parameters

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

      Returns string

    Settings

    +encodeContents | SonarJS linter helper functions

    Function encodeContents

    • encodeContents(message, secondaryLocations?, cost?): string

    • Parameters

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

      Returns string

    Settings

    diff --git a/typedoc/functions/expandMessage.html b/typedoc/functions/expandMessage.html index c2b45085235..7805ed3258a 100644 --- a/typedoc/functions/expandMessage.html +++ b/typedoc/functions/expandMessage.html @@ -1 +1 @@ -expandMessage | SonarJS linter helper functions

    Function expandMessage

    • expandMessage(message, reportDescriptorData): string

    • Parameters

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

      Returns string

    Settings

    +expandMessage | SonarJS linter helper functions

    Function expandMessage

    • expandMessage(message, reportDescriptorData): string

    • Parameters

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

      Returns string

    Settings

    diff --git a/typedoc/functions/findFirstMatchingAncestor.html b/typedoc/functions/findFirstMatchingAncestor.html index bdebf667e82..1c08a3220b6 100644 --- a/typedoc/functions/findFirstMatchingAncestor.html +++ b/typedoc/functions/findFirstMatchingAncestor.html @@ -1 +1 @@ -findFirstMatchingAncestor | SonarJS linter helper functions

    Function findFirstMatchingAncestor

    • findFirstMatchingAncestor(node, predicate): undefined | Node

    • Parameters

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

          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    Settings

    +findFirstMatchingAncestor | SonarJS linter helper functions

    Function findFirstMatchingAncestor

    • findFirstMatchingAncestor(node, predicate): undefined | Node

    • Parameters

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

          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    Settings

    diff --git a/typedoc/functions/findFirstMatchingLocalAncestor.html b/typedoc/functions/findFirstMatchingLocalAncestor.html index 64a776ea689..2d5513b6dab 100644 --- a/typedoc/functions/findFirstMatchingLocalAncestor.html +++ b/typedoc/functions/findFirstMatchingLocalAncestor.html @@ -1 +1 @@ -findFirstMatchingLocalAncestor | SonarJS linter helper functions

    Function findFirstMatchingLocalAncestor

    • findFirstMatchingLocalAncestor(node, predicate): undefined | Node

    • Parameters

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

          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    Settings

    +findFirstMatchingLocalAncestor | SonarJS linter helper functions

    Function findFirstMatchingLocalAncestor

    • findFirstMatchingLocalAncestor(node, predicate): undefined | Node

    • Parameters

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

          • Parameters

            • node: Node

            Returns boolean

      Returns undefined | Node

    Settings

    diff --git a/typedoc/functions/findParent.html b/typedoc/functions/findParent.html index 59913baba78..8ad3e684a7a 100644 --- a/typedoc/functions/findParent.html +++ b/typedoc/functions/findParent.html @@ -1,3 +1,3 @@ findParent | SonarJS linter helper functions

    Function findParent

    • findParent(dir, name): string | null

    • Find nearest file with a given name in current or parent dirs

      Parameters

      • dir: string
      • name: string

        filename to search for

        -

      Returns string | null

    Settings

    +

    Returns string | null

    Settings

    diff --git a/typedoc/functions/findPropagatedSetting.html b/typedoc/functions/findPropagatedSetting.html index db7ed387dd3..b21021b8494 100644 --- a/typedoc/functions/findPropagatedSetting.html +++ b/typedoc/functions/findPropagatedSetting.html @@ -1,2 +1,2 @@ findPropagatedSetting | SonarJS linter helper functions

    Function findPropagatedSetting

    • findPropagatedSetting(sensitiveProperty, propagatedValue): IssueLocation | undefined

    • Finds the propagated setting of a sensitive property

      -

      Parameters

      • sensitiveProperty: Property
      • propagatedValue: Node

      Returns IssueLocation | undefined

    Settings

    +

    Parameters

    Returns IssueLocation | undefined

    Settings

    diff --git a/typedoc/functions/flatMap.html b/typedoc/functions/flatMap.html index 1a5eb61e17f..93151c0c6e7 100644 --- a/typedoc/functions/flatMap.html +++ b/typedoc/functions/flatMap.html @@ -1 +1 @@ -flatMap | SonarJS linter helper functions

    Function flatMap

    • flatMap<A, B>(xs, f): B[]

    • Type Parameters

      • A
      • B

      Parameters

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

          • Parameters

            Returns B[]

      Returns B[]

    Settings

    +flatMap | SonarJS linter helper functions

    Function flatMap

    • flatMap<A, B>(xs, f): B[]

    • Type Parameters

      • A
      • B

      Parameters

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

          • Parameters

            Returns B[]

      Returns B[]

    Settings

    diff --git a/typedoc/functions/flattenArgs.html b/typedoc/functions/flattenArgs.html index 34a0983a0ac..f2076febe7c 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[]

    Settings

    +

    Parameters

    Returns estree.Node[]

    Settings

    diff --git a/typedoc/functions/generateMeta.html b/typedoc/functions/generateMeta.html index 4ea82f54eb9..4f124ef405c 100644 --- a/typedoc/functions/generateMeta.html +++ b/typedoc/functions/generateMeta.html @@ -1 +1 @@ -generateMeta | SonarJS linter helper functions

    Function generateMeta

    • generateMeta(rspecMeta, ruleMeta?, hasSecondaries?): Rule.RuleMetaData

    • Parameters

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

      Returns Rule.RuleMetaData

    Settings

    +generateMeta | SonarJS linter helper functions

    Function generateMeta

    • generateMeta(rspecMeta, ruleMeta?, hasSecondaries?): Rule.RuleMetaData

    • Parameters

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

      Returns Rule.RuleMetaData

    Settings

    diff --git a/typedoc/functions/getBucketProperty.html b/typedoc/functions/getBucketProperty.html index b0a65325e64..b894a7ebf91 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/getDependencies.html b/typedoc/functions/getDependencies.html index 9ddf6839d68..36937a05e9e 100644 --- a/typedoc/functions/getDependencies.html +++ b/typedoc/functions/getDependencies.html @@ -1,4 +1,4 @@ getDependencies | SonarJS linter helper functions

    Function getDependencies

    • getDependencies(filename, cwd): Set<string | Minimatch>

    • 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>

    Settings

    +

    Returns Set<string | Minimatch>

    Settings

    diff --git a/typedoc/functions/getDependenciesFromPackageJson.html b/typedoc/functions/getDependenciesFromPackageJson.html index f6c35f719ac..cc34e8e0543 100644 --- a/typedoc/functions/getDependenciesFromPackageJson.html +++ b/typedoc/functions/getDependenciesFromPackageJson.html @@ -1 +1 @@ -getDependenciesFromPackageJson | SonarJS linter helper functions

    Function getDependenciesFromPackageJson

    • getDependenciesFromPackageJson(content): Set<string | Minimatch>

    • Parameters

      • content: PackageJson

      Returns Set<string | Minimatch>

    Settings

    +getDependenciesFromPackageJson | SonarJS linter helper functions

    Function getDependenciesFromPackageJson

    • getDependenciesFromPackageJson(content): Set<string | Minimatch>

    • Parameters

      • content: PackageJson

      Returns Set<string | Minimatch>

    Settings

    diff --git a/typedoc/functions/getFirstToken.html b/typedoc/functions/getFirstToken.html index c0737a21bef..9ed38be4ed2 100644 --- a/typedoc/functions/getFirstToken.html +++ b/typedoc/functions/getFirstToken.html @@ -1 +1 @@ -getFirstToken | SonarJS linter helper functions

    Function getFirstToken

    • getFirstToken<T>(node, context): TSESLint.AST.Token

    • Type Parameters

      • T = string

      Parameters

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

      Returns TSESLint.AST.Token

    Settings

    +getFirstToken | SonarJS linter helper functions

    Function getFirstToken

    • getFirstToken<T>(node, context): TSESLint.AST.Token

    • Type Parameters

      • T = string

      Parameters

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

      Returns TSESLint.AST.Token

    Settings

    diff --git a/typedoc/functions/getFirstTokenAfter.html b/typedoc/functions/getFirstTokenAfter.html index 1bca82e5710..2fe6d52f97e 100644 --- a/typedoc/functions/getFirstTokenAfter.html +++ b/typedoc/functions/getFirstTokenAfter.html @@ -1 +1 @@ -getFirstTokenAfter | SonarJS linter helper functions

    Function getFirstTokenAfter

    • getFirstTokenAfter<T>(node, context): TSESLint.AST.Token | null

    • Type Parameters

      • T = string

      Parameters

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

      Returns TSESLint.AST.Token | null

    Settings

    +getFirstTokenAfter | SonarJS linter helper functions

    Function getFirstTokenAfter

    • getFirstTokenAfter<T>(node, context): TSESLint.AST.Token | null

    • Type Parameters

      • T = string

      Parameters

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

      Returns TSESLint.AST.Token | null

    Settings

    diff --git a/typedoc/functions/getFullyQualifiedName.html b/typedoc/functions/getFullyQualifiedName.html index 31f4981a649..11c3cc9101e 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

    Settings

    +

    Returns string | null

    Settings

    diff --git a/typedoc/functions/getFullyQualifiedNameRaw.html b/typedoc/functions/getFullyQualifiedNameRaw.html index 0d5105d3125..6138633eac3 100644 --- a/typedoc/functions/getFullyQualifiedNameRaw.html +++ b/typedoc/functions/getFullyQualifiedNameRaw.html @@ -1,3 +1,3 @@ getFullyQualifiedNameRaw | SonarJS linter helper functions

    Function getFullyQualifiedNameRaw

    • getFullyQualifiedNameRaw(context, node, fqn, scope?, visitedVars?): string | null

    • 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

    Settings

    +

    Parameters

    Returns string | null

    Settings

    diff --git a/typedoc/functions/getImportDeclarations.html b/typedoc/functions/getImportDeclarations.html index 66a7020657b..87e6ac19f48 100644 --- a/typedoc/functions/getImportDeclarations.html +++ b/typedoc/functions/getImportDeclarations.html @@ -1 +1 @@ -getImportDeclarations | SonarJS linter helper functions

    Function getImportDeclarations

    • getImportDeclarations(context): ImportDeclaration[]

    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    Settings

    +getImportDeclarations | SonarJS linter helper functions

    Function getImportDeclarations

    • getImportDeclarations(context): ImportDeclaration[]

    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    Settings

    diff --git a/typedoc/functions/getJsxShortCircuitNodes.html b/typedoc/functions/getJsxShortCircuitNodes.html index beab6a2e532..c82fbefe18b 100644 --- a/typedoc/functions/getJsxShortCircuitNodes.html +++ b/typedoc/functions/getJsxShortCircuitNodes.html @@ -1 +1 @@ -getJsxShortCircuitNodes | SonarJS linter helper functions

    Function getJsxShortCircuitNodes

    • getJsxShortCircuitNodes(logicalExpression): null | LogicalExpression[]

    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    Settings

    +getJsxShortCircuitNodes | SonarJS linter helper functions

    Function getJsxShortCircuitNodes

    • getJsxShortCircuitNodes(logicalExpression): null | LogicalExpression[]

    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    Settings

    diff --git a/typedoc/functions/getLhsVariable.html b/typedoc/functions/getLhsVariable.html index 321af0a1440..46cb392c118 100644 --- a/typedoc/functions/getLhsVariable.html +++ b/typedoc/functions/getLhsVariable.html @@ -1,2 +1,2 @@ getLhsVariable | SonarJS linter helper functions

    Function getLhsVariable

    • getLhsVariable(context, node): Scope.Variable | undefined

    • for x = 42 or let x = 42 when visiting '42' returns 'x' variable

      -

      Parameters

      • context: RuleContext
      • node: Node

      Returns Scope.Variable | undefined

    Settings

    +

    Parameters

    Returns Scope.Variable | undefined

    Settings

    diff --git a/typedoc/functions/getLiteralValue.html b/typedoc/functions/getLiteralValue.html index 244f5dad4bb..4fcfcf624b4 100644 --- a/typedoc/functions/getLiteralValue.html +++ b/typedoc/functions/getLiteralValue.html @@ -1 +1 @@ -getLiteralValue | SonarJS linter helper functions

    Function getLiteralValue

    • getLiteralValue(ctx, node): estree.Literal | undefined

    • Parameters

      • ctx: RuleContext
      • node: Node

      Returns estree.Literal | undefined

    Settings

    +getLiteralValue | SonarJS linter helper functions

    Function getLiteralValue

    • getLiteralValue(ctx, node): estree.Literal | undefined

    • Parameters

      • ctx: RuleContext
      • node: Node

      Returns estree.Literal | undefined

    Settings

    diff --git a/typedoc/functions/getMainFunctionTokenLocation.html b/typedoc/functions/getMainFunctionTokenLocation.html index a1d9031653c..84c560953ed 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

    Settings

    +

    Type Parameters

    Parameters

    Returns SourceLocation

    Settings

    diff --git a/typedoc/functions/getManifests.html b/typedoc/functions/getManifests.html index f06268abd4c..4dee34152b5 100644 --- a/typedoc/functions/getManifests.html +++ b/typedoc/functions/getManifests.html @@ -1,3 +1,3 @@ getManifests | SonarJS linter helper functions

    Function getManifests

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

    -
    • getManifests(dir, workingDirectory?, fileSystem?): PackageJson[]

    • Parameters

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

      Returns PackageJson[]

    Settings

    +

    Settings

    diff --git a/typedoc/functions/getNodeParent.html b/typedoc/functions/getNodeParent.html index 5c2d31693cb..c8b4362ba62 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/getParent.html b/typedoc/functions/getParent.html index 8b0ee314b79..f0c33ccc3f5 100644 --- a/typedoc/functions/getParent.html +++ b/typedoc/functions/getParent.html @@ -1 +1 @@ -getParent | SonarJS linter helper functions

    Function getParent

    • getParent(context, node):
          | 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

    • 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

    Settings

    +getParent | SonarJS linter helper functions

    Function getParent

    • getParent(context, node):
          | 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

    • 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

    Settings

    diff --git a/typedoc/functions/getProgramStatements.html b/typedoc/functions/getProgramStatements.html index 5da36644f54..1d0483488e8 100644 --- a/typedoc/functions/getProgramStatements.html +++ b/typedoc/functions/getProgramStatements.html @@ -1 +1 @@ -getProgramStatements | SonarJS linter helper functions

    Function getProgramStatements

    • getProgramStatements(program): Statement[]

    • Parameters

      • program: Program

      Returns Statement[]

    Settings

    +getProgramStatements | SonarJS linter helper functions

    Function getProgramStatements

    • getProgramStatements(program): Statement[]

    • Parameters

      • program: Program

      Returns Statement[]

    Settings

    diff --git a/typedoc/functions/getProperty.html b/typedoc/functions/getProperty.html index 75542d9b1f2..09fd916974e 100644 --- a/typedoc/functions/getProperty.html +++ b/typedoc/functions/getProperty.html @@ -1,4 +1,4 @@ getProperty | SonarJS linter helper functions

    Function getProperty

    • getProperty(expr, key, ctx): estree.Property | null | undefined

    • 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.

      -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/getPropertyWithValue.html b/typedoc/functions/getPropertyWithValue.html index 10889f774e3..586985f268d 100644 --- a/typedoc/functions/getPropertyWithValue.html +++ b/typedoc/functions/getPropertyWithValue.html @@ -1 +1 @@ -getPropertyWithValue | SonarJS linter helper functions

    Function getPropertyWithValue

    • getPropertyWithValue(context, objectExpression, propertyName, propertyValue): estree.Property | undefined

    • Parameters

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

      Returns estree.Property | undefined

    Settings

    +getPropertyWithValue | SonarJS linter helper functions

    Function getPropertyWithValue

    • getPropertyWithValue(context, objectExpression, propertyName, propertyValue): estree.Property | undefined

    • Parameters

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

      Returns estree.Property | undefined

    Settings

    diff --git a/typedoc/functions/getRequireCalls.html b/typedoc/functions/getRequireCalls.html index 16ab280130a..3560819325e 100644 --- a/typedoc/functions/getRequireCalls.html +++ b/typedoc/functions/getRequireCalls.html @@ -1 +1 @@ -getRequireCalls | SonarJS linter helper functions

    Function getRequireCalls

    • getRequireCalls(context): CallExpression[]

    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    Settings

    +getRequireCalls | SonarJS linter helper functions

    Function getRequireCalls

    • getRequireCalls(context): CallExpression[]

    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    Settings

    diff --git a/typedoc/functions/getSensitiveEffect.html b/typedoc/functions/getSensitiveEffect.html index ad55484c4f9..690dab34cdb 100644 --- a/typedoc/functions/getSensitiveEffect.html +++ b/typedoc/functions/getSensitiveEffect.html @@ -1 +1 @@ -getSensitiveEffect | SonarJS linter helper functions

    Function getSensitiveEffect

    Settings

    +getSensitiveEffect | SonarJS linter helper functions

    Function getSensitiveEffect

    Settings

    diff --git a/typedoc/functions/getSignatureFromCallee.html b/typedoc/functions/getSignatureFromCallee.html index f5307a748a7..c5837c11d2c 100644 --- a/typedoc/functions/getSignatureFromCallee.html +++ b/typedoc/functions/getSignatureFromCallee.html @@ -1 +1 @@ -getSignatureFromCallee | SonarJS linter helper functions

    Function getSignatureFromCallee

    • getSignatureFromCallee(node, services): undefined | Signature

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    Settings

    +getSignatureFromCallee | SonarJS linter helper functions

    Function getSignatureFromCallee

    • getSignatureFromCallee(node, services): undefined | Signature

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    Settings

    diff --git a/typedoc/functions/getSimpleRawStringValue.html b/typedoc/functions/getSimpleRawStringValue.html index bedb45b9c74..545eb0e9717 100644 --- a/typedoc/functions/getSimpleRawStringValue.html +++ b/typedoc/functions/getSimpleRawStringValue.html @@ -1 +1 @@ -getSimpleRawStringValue | SonarJS linter helper functions

    Function getSimpleRawStringValue

    • getSimpleRawStringValue(node): string

    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    Settings

    +getSimpleRawStringValue | SonarJS linter helper functions

    Function getSimpleRawStringValue

    • getSimpleRawStringValue(node): string

    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    Settings

    diff --git a/typedoc/functions/getSymbolAtLocation.html b/typedoc/functions/getSymbolAtLocation.html index 1a630f87aea..4e991ad6d8f 100644 --- a/typedoc/functions/getSymbolAtLocation.html +++ b/typedoc/functions/getSymbolAtLocation.html @@ -1 +1 @@ -getSymbolAtLocation | SonarJS linter helper functions

    Function getSymbolAtLocation

    • getSymbolAtLocation(node, services): undefined | Symbol

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    Settings

    +getSymbolAtLocation | SonarJS linter helper functions

    Function getSymbolAtLocation

    • getSymbolAtLocation(node, services): undefined | Symbol

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    Settings

    diff --git a/typedoc/functions/getTypeAsString.html b/typedoc/functions/getTypeAsString.html index 8cffcf2d7a4..e2453d8f95d 100644 --- a/typedoc/functions/getTypeAsString.html +++ b/typedoc/functions/getTypeAsString.html @@ -1 +1 @@ -getTypeAsString | SonarJS linter helper functions

    Function getTypeAsString

    • getTypeAsString(node, services): string

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    Settings

    +getTypeAsString | SonarJS linter helper functions

    Function getTypeAsString

    • getTypeAsString(node, services): string

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    Settings

    diff --git a/typedoc/functions/getTypeFromTreeNode.html b/typedoc/functions/getTypeFromTreeNode.html index 7994160eae0..e3ebb29ef1c 100644 --- a/typedoc/functions/getTypeFromTreeNode.html +++ b/typedoc/functions/getTypeFromTreeNode.html @@ -1 +1 @@ -getTypeFromTreeNode | SonarJS linter helper functions

    Function getTypeFromTreeNode

    • getTypeFromTreeNode(node, services): Type

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    Settings

    +getTypeFromTreeNode | SonarJS linter helper functions

    Function getTypeFromTreeNode

    • getTypeFromTreeNode(node, services): Type

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    Settings

    diff --git a/typedoc/functions/getUnionTypes.html b/typedoc/functions/getUnionTypes.html index 8e3f096c2a2..e4ebcbc619e 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.

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/getUniqueWriteReference.html b/typedoc/functions/getUniqueWriteReference.html index 7c568c050f9..10c28c367e2 100644 --- a/typedoc/functions/getUniqueWriteReference.html +++ b/typedoc/functions/getUniqueWriteReference.html @@ -1 +1 @@ -getUniqueWriteReference | SonarJS linter helper functions

    Function getUniqueWriteReference

    • getUniqueWriteReference(variable): estree.Node | undefined

    • Parameters

      • variable: undefined | Variable

      Returns estree.Node | undefined

    Settings

    +getUniqueWriteReference | SonarJS linter helper functions

    Function getUniqueWriteReference

    • getUniqueWriteReference(variable): estree.Node | undefined

    • Parameters

      • variable: undefined | Variable

      Returns estree.Node | undefined

    Settings

    diff --git a/typedoc/functions/getUniqueWriteUsage.html b/typedoc/functions/getUniqueWriteUsage.html index c3645cdc030..a3a73a8e1e2 100644 --- a/typedoc/functions/getUniqueWriteUsage.html +++ b/typedoc/functions/getUniqueWriteUsage.html @@ -1 +1 @@ -getUniqueWriteUsage | SonarJS linter helper functions

    Function getUniqueWriteUsage

    • getUniqueWriteUsage(context, name, node): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    +getUniqueWriteUsage | SonarJS linter helper functions

    Function getUniqueWriteUsage

    • getUniqueWriteUsage(context, name, node): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    diff --git a/typedoc/functions/getUniqueWriteUsageOrNode.html b/typedoc/functions/getUniqueWriteUsageOrNode.html index 46d1d75029d..5b36b9ea133 100644 --- a/typedoc/functions/getUniqueWriteUsageOrNode.html +++ b/typedoc/functions/getUniqueWriteUsageOrNode.html @@ -1 +1 @@ -getUniqueWriteUsageOrNode | SonarJS linter helper functions

    Function getUniqueWriteUsageOrNode

    • getUniqueWriteUsageOrNode(context, node, recursive?): estree.Node

    • Parameters

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

      Returns estree.Node

    Settings

    +getUniqueWriteUsageOrNode | SonarJS linter helper functions

    Function getUniqueWriteUsageOrNode

    • getUniqueWriteUsageOrNode(context, node, recursive?): estree.Node

    • Parameters

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

      Returns estree.Node

    Settings

    diff --git a/typedoc/functions/getValueOfExpression.html b/typedoc/functions/getValueOfExpression.html index 8a4cb8b3f55..81355996cca 100644 --- a/typedoc/functions/getValueOfExpression.html +++ b/typedoc/functions/getValueOfExpression.html @@ -1 +1 @@ -getValueOfExpression | SonarJS linter helper functions

    Function getValueOfExpression

    • getValueOfExpression<T>(context, expr, type, recursive?): Extract<estree.Node, {
          type: T;
      }> | undefined

    • 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

    Settings

    +getValueOfExpression | SonarJS linter helper functions

    Function getValueOfExpression

    • getValueOfExpression<T>(context, expr, type, recursive?): Extract<estree.Node, {
          type: T;
      }> | undefined

    • 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

    Settings

    diff --git a/typedoc/functions/getVariableFromIdentifier.html b/typedoc/functions/getVariableFromIdentifier.html index f92c5a69969..d65aa00f12d 100644 --- a/typedoc/functions/getVariableFromIdentifier.html +++ b/typedoc/functions/getVariableFromIdentifier.html @@ -1 +1 @@ -getVariableFromIdentifier | SonarJS linter helper functions

    Function getVariableFromIdentifier

    • getVariableFromIdentifier(identifier, scope): undefined | Variable

    • Parameters

      • identifier: Identifier
      • scope: Scope

      Returns undefined | Variable

    Settings

    +getVariableFromIdentifier | SonarJS linter helper functions

    Function getVariableFromIdentifier

    • getVariableFromIdentifier(identifier, scope): undefined | Variable

    • Parameters

      • identifier: Identifier
      • scope: Scope

      Returns undefined | Variable

    Settings

    diff --git a/typedoc/functions/getVariableFromName.html b/typedoc/functions/getVariableFromName.html index c9552523326..1e805a42852 100644 --- a/typedoc/functions/getVariableFromName.html +++ b/typedoc/functions/getVariableFromName.html @@ -1 +1 @@ -getVariableFromName | SonarJS linter helper functions

    Function getVariableFromName

    • getVariableFromName(context, name, node): undefined | Variable

    • Parameters

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

      Returns undefined | Variable

    Settings

    +getVariableFromName | SonarJS linter helper functions

    Function getVariableFromName

    • getVariableFromName(context, name, node): undefined | Variable

    • Parameters

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

      Returns undefined | Variable

    Settings

    diff --git a/typedoc/functions/getVariableFromScope.html b/typedoc/functions/getVariableFromScope.html index 3101ee8980c..bce1a824e29 100644 --- a/typedoc/functions/getVariableFromScope.html +++ b/typedoc/functions/getVariableFromScope.html @@ -1 +1 @@ -getVariableFromScope | SonarJS linter helper functions

    Function getVariableFromScope

    • getVariableFromScope(scope, name): undefined | Variable

    • Parameters

      • scope: null | Scope
      • name: string

      Returns undefined | Variable

    Settings

    +getVariableFromScope | SonarJS linter helper functions

    Function getVariableFromScope

    • getVariableFromScope(scope, name): undefined | Variable

    • Parameters

      • scope: null | Scope
      • name: string

      Returns undefined | Variable

    Settings

    diff --git a/typedoc/functions/interceptReport.html b/typedoc/functions/interceptReport.html index 3ce09c6c78b..921e3da9968 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

    Settings

    +

    Returns Rule.RuleModule

    Settings

    diff --git a/typedoc/functions/interceptReportForReact.html b/typedoc/functions/interceptReportForReact.html index 47b0dcf3563..db34dc4771d 100644 --- a/typedoc/functions/interceptReportForReact.html +++ b/typedoc/functions/interceptReportForReact.html @@ -1 +1 @@ -interceptReportForReact | SonarJS linter helper functions

    Function interceptReportForReact

    Settings

    +interceptReportForReact | SonarJS linter helper functions

    Function interceptReportForReact

    Settings

    diff --git a/typedoc/functions/isAny.html b/typedoc/functions/isAny.html index ee7baab2019..efccac67a43 100644 --- a/typedoc/functions/isAny.html +++ b/typedoc/functions/isAny.html @@ -1 +1 @@ -isAny | SonarJS linter helper functions

    Function isAny

    • isAny(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isAny | SonarJS linter helper functions

    Function isAny

    • isAny(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isAnyLiteral.html b/typedoc/functions/isAnyLiteral.html index ea8ace26d18..f19ea98bb30 100644 --- a/typedoc/functions/isAnyLiteral.html +++ b/typedoc/functions/isAnyLiteral.html @@ -1 +1 @@ -isAnyLiteral | SonarJS linter helper functions

    Function isAnyLiteral

    Settings

    +isAnyLiteral | SonarJS linter helper functions

    Function isAnyLiteral

    Settings

    diff --git a/typedoc/functions/isArray.html b/typedoc/functions/isArray.html index e97a664dd78..bb9d7485046 100644 --- a/typedoc/functions/isArray.html +++ b/typedoc/functions/isArray.html @@ -1 +1 @@ -isArray | SonarJS linter helper functions

    Function isArray

    • isArray(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isArray | SonarJS linter helper functions

    Function isArray

    • isArray(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isArrayExpression.html b/typedoc/functions/isArrayExpression.html index 1a97bdcf400..58aa4a2e78a 100644 --- a/typedoc/functions/isArrayExpression.html +++ b/typedoc/functions/isArrayExpression.html @@ -1 +1 @@ -isArrayExpression | SonarJS linter helper functions

    Function isArrayExpression

    • isArrayExpression(node): node is ArrayExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrayExpression

    Settings

    +isArrayExpression | SonarJS linter helper functions

    Function isArrayExpression

    • isArrayExpression(node): node is ArrayExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrayExpression

    Settings

    diff --git a/typedoc/functions/isArrayLikeType.html b/typedoc/functions/isArrayLikeType.html index 8c2561678c4..74da931c489 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

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isArrowFunctionExpression.html b/typedoc/functions/isArrowFunctionExpression.html index 71f73aaaea9..47fceb52895 100644 --- a/typedoc/functions/isArrowFunctionExpression.html +++ b/typedoc/functions/isArrowFunctionExpression.html @@ -1 +1 @@ -isArrowFunctionExpression | SonarJS linter helper functions

    Function isArrowFunctionExpression

    • isArrowFunctionExpression(node): node is ArrowFunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrowFunctionExpression

    Settings

    +isArrowFunctionExpression | SonarJS linter helper functions

    Function isArrowFunctionExpression

    • isArrowFunctionExpression(node): node is ArrowFunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrowFunctionExpression

    Settings

    diff --git a/typedoc/functions/isBigIntArray.html b/typedoc/functions/isBigIntArray.html index 9fe6ade82e9..d06343f4e66 100644 --- a/typedoc/functions/isBigIntArray.html +++ b/typedoc/functions/isBigIntArray.html @@ -1,4 +1,4 @@ isBigIntArray | SonarJS linter helper functions

    Function isBigIntArray

    • isBigIntArray(type, services): boolean

    • 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

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isBigIntType.html b/typedoc/functions/isBigIntType.html index 023049a637c..cbb0cbf4d64 100644 --- a/typedoc/functions/isBigIntType.html +++ b/typedoc/functions/isBigIntType.html @@ -1 +1 @@ -isBigIntType | SonarJS linter helper functions

    Function isBigIntType

    • isBigIntType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isBigIntType | SonarJS linter helper functions

    Function isBigIntType

    • isBigIntType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isBinaryPlus.html b/typedoc/functions/isBinaryPlus.html index 6d74b0dde81..6af70c8ea6d 100644 --- a/typedoc/functions/isBinaryPlus.html +++ b/typedoc/functions/isBinaryPlus.html @@ -1 +1 @@ -isBinaryPlus | SonarJS linter helper functions

    Function isBinaryPlus

    • isBinaryPlus(node): node is BinaryExpression & {
          operator: "+";
      }

    • Parameters

      • node: Node

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

    Settings

    +isBinaryPlus | SonarJS linter helper functions

    Function isBinaryPlus

    • isBinaryPlus(node): node is BinaryExpression & {
          operator: "+";
      }

    • Parameters

      • node: Node

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

    Settings

    diff --git a/typedoc/functions/isBooleanLiteral.html b/typedoc/functions/isBooleanLiteral.html index d780aa5701c..2697121aca2 100644 --- a/typedoc/functions/isBooleanLiteral.html +++ b/typedoc/functions/isBooleanLiteral.html @@ -1 +1 @@ -isBooleanLiteral | SonarJS linter helper functions

    Function isBooleanLiteral

    • isBooleanLiteral(node): node is Literal & {
          value: boolean;
      }

    • Parameters

      • node: Node

      Returns node is Literal & {
          value: boolean;
      }

    Settings

    +isBooleanLiteral | SonarJS linter helper functions

    Function isBooleanLiteral

    • isBooleanLiteral(node): node is Literal & {
          value: boolean;
      }

    • Parameters

      • node: Node

      Returns node is Literal & {
          value: boolean;
      }

    Settings

    diff --git a/typedoc/functions/isBooleanLiteralType.html b/typedoc/functions/isBooleanLiteralType.html index 5af3aa472c0..4e9ef279f43 100644 --- a/typedoc/functions/isBooleanLiteralType.html +++ b/typedoc/functions/isBooleanLiteralType.html @@ -1 +1 @@ -isBooleanLiteralType | SonarJS linter helper functions

    Function isBooleanLiteralType

    • isBooleanLiteralType(type): type is Type & {
          intrinsicName: "true" | "false";
      }

    • Parameters

      • type: Type

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

    Settings

    +isBooleanLiteralType | SonarJS linter helper functions

    Function isBooleanLiteralType

    • isBooleanLiteralType(type): type is Type & {
          intrinsicName: "true" | "false";
      }

    • Parameters

      • type: Type

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

    Settings

    diff --git a/typedoc/functions/isBooleanTrueType.html b/typedoc/functions/isBooleanTrueType.html index 7724ead2e35..9b0b72d0c95 100644 --- a/typedoc/functions/isBooleanTrueType.html +++ b/typedoc/functions/isBooleanTrueType.html @@ -1 +1 @@ -isBooleanTrueType | SonarJS linter helper functions

    Function isBooleanTrueType

    • isBooleanTrueType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isBooleanTrueType | SonarJS linter helper functions

    Function isBooleanTrueType

    • isBooleanTrueType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isBooleanType.html b/typedoc/functions/isBooleanType.html index 71712c9fd93..47871851f9f 100644 --- a/typedoc/functions/isBooleanType.html +++ b/typedoc/functions/isBooleanType.html @@ -1 +1 @@ -isBooleanType | SonarJS linter helper functions

    Function isBooleanType

    • isBooleanType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isBooleanType | SonarJS linter helper functions

    Function isBooleanType

    • isBooleanType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isCallingMethod.html b/typedoc/functions/isCallingMethod.html index ded5c73d3f9..e1fefb577c1 100644 --- a/typedoc/functions/isCallingMethod.html +++ b/typedoc/functions/isCallingMethod.html @@ -1 +1 @@ -isCallingMethod | SonarJS linter helper functions

    Function isCallingMethod

    • isCallingMethod(callExpr, arity, ...methodNames): callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    • Parameters

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

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

    Settings

    +isCallingMethod | SonarJS linter helper functions

    Function isCallingMethod

    • isCallingMethod(callExpr, arity, ...methodNames): callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    • Parameters

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

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

    Settings

    diff --git a/typedoc/functions/isDefaultSpecifier.html b/typedoc/functions/isDefaultSpecifier.html index 1ef16bd9e4b..b5511f26abe 100644 --- a/typedoc/functions/isDefaultSpecifier.html +++ b/typedoc/functions/isDefaultSpecifier.html @@ -1 +1 @@ -isDefaultSpecifier | SonarJS linter helper functions

    Function isDefaultSpecifier

    • isDefaultSpecifier(importDeclaration, name): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    +isDefaultSpecifier | SonarJS linter helper functions

    Function isDefaultSpecifier

    • isDefaultSpecifier(importDeclaration, name): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isDotNotation.html b/typedoc/functions/isDotNotation.html index 1e6a3693539..769121270ff 100644 --- a/typedoc/functions/isDotNotation.html +++ b/typedoc/functions/isDotNotation.html @@ -1,2 +1,2 @@ isDotNotation | SonarJS linter helper functions

    Function isDotNotation

    • isDotNotation(node): node is MemberExpression & {
          property: Identifier;
      }

    • Checks if the node is of the form: foo.bar

      -

      Parameters

      • node: Node

      Returns node is MemberExpression & {
          property: Identifier;
      }

    Settings

    +

    Parameters

    Returns node is MemberExpression & {
        property: Identifier;
    }

    Settings

    diff --git a/typedoc/functions/isElementWrite.html b/typedoc/functions/isElementWrite.html index 4b065ffc287..20c2f233e84 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isFalseLiteral.html b/typedoc/functions/isFalseLiteral.html index 8f9e4e8d660..15ac0b2a7e3 100644 --- a/typedoc/functions/isFalseLiteral.html +++ b/typedoc/functions/isFalseLiteral.html @@ -1 +1 @@ -isFalseLiteral | SonarJS linter helper functions

    Function isFalseLiteral

    • isFalseLiteral(n): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    +isFalseLiteral | SonarJS linter helper functions

    Function isFalseLiteral

    • isFalseLiteral(n): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isFunction.html b/typedoc/functions/isFunction.html index 88b55b8d5cb..514e5a70cca 100644 --- a/typedoc/functions/isFunction.html +++ b/typedoc/functions/isFunction.html @@ -1 +1 @@ -isFunction | SonarJS linter helper functions

    Function isFunction

    • isFunction(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isFunction | SonarJS linter helper functions

    Function isFunction

    • isFunction(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isFunctionCall.html b/typedoc/functions/isFunctionCall.html index bd670824725..cb084e5faec 100644 --- a/typedoc/functions/isFunctionCall.html +++ b/typedoc/functions/isFunctionCall.html @@ -1 +1 @@ -isFunctionCall | SonarJS linter helper functions

    Function isFunctionCall

    • isFunctionCall(node): node is CallExpression & {
          callee: Identifier;
      }

    • Parameters

      • node: Node

      Returns node is CallExpression & {
          callee: Identifier;
      }

    Settings

    +isFunctionCall | SonarJS linter helper functions

    Function isFunctionCall

    • isFunctionCall(node): node is CallExpression & {
          callee: Identifier;
      }

    • Parameters

      • node: Node

      Returns node is CallExpression & {
          callee: Identifier;
      }

    Settings

    diff --git a/typedoc/functions/isFunctionDeclaration.html b/typedoc/functions/isFunctionDeclaration.html index 986f8cf6199..a7fb3e82ede 100644 --- a/typedoc/functions/isFunctionDeclaration.html +++ b/typedoc/functions/isFunctionDeclaration.html @@ -1 +1 @@ -isFunctionDeclaration | SonarJS linter helper functions

    Function isFunctionDeclaration

    • isFunctionDeclaration(node): node is FunctionDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is FunctionDeclaration

    Settings

    +isFunctionDeclaration | SonarJS linter helper functions

    Function isFunctionDeclaration

    • isFunctionDeclaration(node): node is FunctionDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is FunctionDeclaration

    Settings

    diff --git a/typedoc/functions/isFunctionExpression.html b/typedoc/functions/isFunctionExpression.html index 376f9c4dba9..2242add5754 100644 --- a/typedoc/functions/isFunctionExpression.html +++ b/typedoc/functions/isFunctionExpression.html @@ -1 +1 @@ -isFunctionExpression | SonarJS linter helper functions

    Function isFunctionExpression

    • isFunctionExpression(node): node is FunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is FunctionExpression

    Settings

    +isFunctionExpression | SonarJS linter helper functions

    Function isFunctionExpression

    • isFunctionExpression(node): node is FunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is FunctionExpression

    Settings

    diff --git a/typedoc/functions/isFunctionInvocation.html b/typedoc/functions/isFunctionInvocation.html index 9f247047e7d..6d46c139f3f 100644 --- a/typedoc/functions/isFunctionInvocation.html +++ b/typedoc/functions/isFunctionInvocation.html @@ -1 +1 @@ -isFunctionInvocation | SonarJS linter helper functions

    Function isFunctionInvocation

    • isFunctionInvocation(callExpression, functionName, minArgs): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isFunctionInvocation | SonarJS linter helper functions

    Function isFunctionInvocation

    • isFunctionInvocation(callExpression, functionName, minArgs): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isFunctionNode.html b/typedoc/functions/isFunctionNode.html index b0ff27e784d..dab5dce495d 100644 --- a/typedoc/functions/isFunctionNode.html +++ b/typedoc/functions/isFunctionNode.html @@ -1 +1 @@ -isFunctionNode | SonarJS linter helper functions

    Function isFunctionNode

    Settings

    +isFunctionNode | SonarJS linter helper functions

    Function isFunctionNode

    Settings

    diff --git a/typedoc/functions/isGenericType.html b/typedoc/functions/isGenericType.html index c6e34a319ff..f2a5f0852f6 100644 --- a/typedoc/functions/isGenericType.html +++ b/typedoc/functions/isGenericType.html @@ -4,4 +4,4 @@ }

    Parameters

    Returns boolean

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isIdentifier.html b/typedoc/functions/isIdentifier.html index b1da48b7b51..47efb2b8d12 100644 --- a/typedoc/functions/isIdentifier.html +++ b/typedoc/functions/isIdentifier.html @@ -1 +1 @@ -isIdentifier | SonarJS linter helper functions

    Function isIdentifier

    • isIdentifier(node, ...values): node is Identifier

    • Parameters

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

      Returns node is Identifier

    Settings

    +isIdentifier | SonarJS linter helper functions

    Function isIdentifier

    • isIdentifier(node, ...values): node is Identifier

    • Parameters

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

      Returns node is Identifier

    Settings

    diff --git a/typedoc/functions/isIfStatement.html b/typedoc/functions/isIfStatement.html index ed6ff9c5389..e47fa892e8d 100644 --- a/typedoc/functions/isIfStatement.html +++ b/typedoc/functions/isIfStatement.html @@ -1 +1 @@ -isIfStatement | SonarJS linter helper functions

    Function isIfStatement

    • isIfStatement(node): node is IfStatement

    • Parameters

      • node: undefined | Node

      Returns node is IfStatement

    Settings

    +isIfStatement | SonarJS linter helper functions

    Function isIfStatement

    • isIfStatement(node): node is IfStatement

    • Parameters

      • node: undefined | Node

      Returns node is IfStatement

    Settings

    diff --git a/typedoc/functions/isIndexNotation.html b/typedoc/functions/isIndexNotation.html index 92872b2db24..dd41f2f8211 100644 --- a/typedoc/functions/isIndexNotation.html +++ b/typedoc/functions/isIndexNotation.html @@ -1,2 +1,2 @@ isIndexNotation | SonarJS linter helper functions

    Function isIndexNotation

    • isIndexNotation(node): node is MemberExpression & {
          property: StringLiteral;
      }

    • Checks if the node is of the form: foo["bar"]

      -

      Parameters

      • node: Node

      Returns node is MemberExpression & {
          property: StringLiteral;
      }

    Settings

    +

    Parameters

    Returns node is MemberExpression & {
        property: StringLiteral;
    }

    Settings

    diff --git a/typedoc/functions/isInsideVueSetupScript.html b/typedoc/functions/isInsideVueSetupScript.html index 9cad2c76741..473c96667c6 100644 --- a/typedoc/functions/isInsideVueSetupScript.html +++ b/typedoc/functions/isInsideVueSetupScript.html @@ -1 +1 @@ -isInsideVueSetupScript | SonarJS linter helper functions

    Function isInsideVueSetupScript

    • isInsideVueSetupScript(node, ctx): boolean

    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    Settings

    +isInsideVueSetupScript | SonarJS linter helper functions

    Function isInsideVueSetupScript

    • isInsideVueSetupScript(node, ctx): boolean

    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isLiteral.html b/typedoc/functions/isLiteral.html index c6a0364711b..2d1e60dfe5e 100644 --- a/typedoc/functions/isLiteral.html +++ b/typedoc/functions/isLiteral.html @@ -1 +1 @@ -isLiteral | SonarJS linter helper functions

    Function isLiteral

    • isLiteral(n): n is Literal

    • Parameters

      • n: null | Node

      Returns n is Literal

    Settings

    +isLiteral | SonarJS linter helper functions

    Function isLiteral

    • isLiteral(n): n is Literal

    • Parameters

      • n: null | Node

      Returns n is Literal

    Settings

    diff --git a/typedoc/functions/isLogicalExpression.html b/typedoc/functions/isLogicalExpression.html index 9bd232472b1..41e5b321423 100644 --- a/typedoc/functions/isLogicalExpression.html +++ b/typedoc/functions/isLogicalExpression.html @@ -1 +1 @@ -isLogicalExpression | SonarJS linter helper functions

    Function isLogicalExpression

    • isLogicalExpression(node): node is LogicalExpression

    • Parameters

      • node: undefined | Node

      Returns node is LogicalExpression

    Settings

    +isLogicalExpression | SonarJS linter helper functions

    Function isLogicalExpression

    • isLogicalExpression(node): node is LogicalExpression

    • Parameters

      • node: undefined | Node

      Returns node is LogicalExpression

    Settings

    diff --git a/typedoc/functions/isMemberExpression.html b/typedoc/functions/isMemberExpression.html index b646cb1e744..3e4075b494f 100644 --- a/typedoc/functions/isMemberExpression.html +++ b/typedoc/functions/isMemberExpression.html @@ -1 +1 @@ -isMemberExpression | SonarJS linter helper functions

    Function isMemberExpression

    • isMemberExpression(node, objectValue, ...propertyValue): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMemberExpression | SonarJS linter helper functions

    Function isMemberExpression

    • isMemberExpression(node, objectValue, ...propertyValue): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isMemberWithProperty.html b/typedoc/functions/isMemberWithProperty.html index a33a69d325f..73c1b9ece75 100644 --- a/typedoc/functions/isMemberWithProperty.html +++ b/typedoc/functions/isMemberWithProperty.html @@ -1 +1 @@ -isMemberWithProperty | SonarJS linter helper functions

    Function isMemberWithProperty

    • isMemberWithProperty(node, ...values): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMemberWithProperty | SonarJS linter helper functions

    Function isMemberWithProperty

    • isMemberWithProperty(node, ...values): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isMethodCall.html b/typedoc/functions/isMethodCall.html index 7fe7cf65722..427a8c27236 100644 --- a/typedoc/functions/isMethodCall.html +++ b/typedoc/functions/isMethodCall.html @@ -1 +1 @@ -isMethodCall | SonarJS linter helper functions

    Function isMethodCall

    • isMethodCall(callExpr): callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    • Parameters

      • callExpr: CallExpression

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

    Settings

    +isMethodCall | SonarJS linter helper functions

    Function isMethodCall

    • isMethodCall(callExpr): callExpr is CallExpression & {
          callee: MemberExpression & {
              property: Identifier;
          };
      }

    • Parameters

      • callExpr: CallExpression

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

    Settings

    diff --git a/typedoc/functions/isMethodInvocation.html b/typedoc/functions/isMethodInvocation.html index 286e2355597..89d3c79c061 100644 --- a/typedoc/functions/isMethodInvocation.html +++ b/typedoc/functions/isMethodInvocation.html @@ -1 +1 @@ -isMethodInvocation | SonarJS linter helper functions

    Function isMethodInvocation

    • isMethodInvocation(callExpression, objectIdentifierName, methodName, minArgs): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMethodInvocation | SonarJS linter helper functions

    Function isMethodInvocation

    • isMethodInvocation(callExpression, objectIdentifierName, methodName, minArgs): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isModuleDeclaration.html b/typedoc/functions/isModuleDeclaration.html index c0a136ff8ed..60f1142c78e 100644 --- a/typedoc/functions/isModuleDeclaration.html +++ b/typedoc/functions/isModuleDeclaration.html @@ -1 +1 @@ -isModuleDeclaration | SonarJS linter helper functions

    Function isModuleDeclaration

    • isModuleDeclaration(node): node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    Settings

    +isModuleDeclaration | SonarJS linter helper functions

    Function isModuleDeclaration

    • isModuleDeclaration(node): node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is
          | ImportDeclaration
          | ExportNamedDeclaration
          | ExportDefaultDeclaration
          | ExportAllDeclaration

    Settings

    diff --git a/typedoc/functions/isModuleExports.html b/typedoc/functions/isModuleExports.html index daa12b6eb75..5adda9b1542 100644 --- a/typedoc/functions/isModuleExports.html +++ b/typedoc/functions/isModuleExports.html @@ -1 +1 @@ -isModuleExports | SonarJS linter helper functions

    Function isModuleExports

    • isModuleExports(node): boolean

    • Parameters

      • node: Node

      Returns boolean

    Settings

    +isModuleExports | SonarJS linter helper functions

    Function isModuleExports

    • isModuleExports(node): boolean

    • Parameters

      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNamespaceSpecifier.html b/typedoc/functions/isNamespaceSpecifier.html index bb51ea3b70f..04f7c0a2e29 100644 --- a/typedoc/functions/isNamespaceSpecifier.html +++ b/typedoc/functions/isNamespaceSpecifier.html @@ -1 +1 @@ -isNamespaceSpecifier | SonarJS linter helper functions

    Function isNamespaceSpecifier

    • isNamespaceSpecifier(importDeclaration, name): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    +isNamespaceSpecifier | SonarJS linter helper functions

    Function isNamespaceSpecifier

    • isNamespaceSpecifier(importDeclaration, name): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNullLiteral.html b/typedoc/functions/isNullLiteral.html index daf172d080e..db590159353 100644 --- a/typedoc/functions/isNullLiteral.html +++ b/typedoc/functions/isNullLiteral.html @@ -1 +1 @@ -isNullLiteral | SonarJS linter helper functions

    Function isNullLiteral

    • isNullLiteral(n): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    +isNullLiteral | SonarJS linter helper functions

    Function isNullLiteral

    • isNullLiteral(n): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNullOrUndefinedType.html b/typedoc/functions/isNullOrUndefinedType.html index 8c431a49ba4..6ac12092e9f 100644 --- a/typedoc/functions/isNullOrUndefinedType.html +++ b/typedoc/functions/isNullOrUndefinedType.html @@ -1 +1 @@ -isNullOrUndefinedType | SonarJS linter helper functions

    Function isNullOrUndefinedType

    • isNullOrUndefinedType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isNullOrUndefinedType | SonarJS linter helper functions

    Function isNullOrUndefinedType

    • isNullOrUndefinedType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isNumber.html b/typedoc/functions/isNumber.html index 51971617073..9c129ad61fe 100644 --- a/typedoc/functions/isNumber.html +++ b/typedoc/functions/isNumber.html @@ -1 +1 @@ -isNumber | SonarJS linter helper functions

    Function isNumber

    • isNumber(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isNumber | SonarJS linter helper functions

    Function isNumber

    • isNumber(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNumberArray.html b/typedoc/functions/isNumberArray.html index 66f61159809..61a39f2ef9c 100644 --- a/typedoc/functions/isNumberArray.html +++ b/typedoc/functions/isNumberArray.html @@ -1,4 +1,4 @@ isNumberArray | SonarJS linter helper functions

    Function isNumberArray

    • isNumberArray(type, services): boolean

    • 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

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isNumberLiteral.html b/typedoc/functions/isNumberLiteral.html index 83c102422e0..5bf2d65eabb 100644 --- a/typedoc/functions/isNumberLiteral.html +++ b/typedoc/functions/isNumberLiteral.html @@ -1 +1 @@ -isNumberLiteral | SonarJS linter helper functions

    Function isNumberLiteral

    • isNumberLiteral(node): node is Literal & {
          value: number;
      }

    • Parameters

      • node: Node

      Returns node is Literal & {
          value: number;
      }

    Settings

    +isNumberLiteral | SonarJS linter helper functions

    Function isNumberLiteral

    • isNumberLiteral(node): node is Literal & {
          value: number;
      }

    • Parameters

      • node: Node

      Returns node is Literal & {
          value: number;
      }

    Settings

    diff --git a/typedoc/functions/isNumberType.html b/typedoc/functions/isNumberType.html index f1f7f5570de..5a80e3924b4 100644 --- a/typedoc/functions/isNumberType.html +++ b/typedoc/functions/isNumberType.html @@ -1 +1 @@ -isNumberType | SonarJS linter helper functions

    Function isNumberType

    • isNumberType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isNumberType | SonarJS linter helper functions

    Function isNumberType

    • isNumberType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isObjectDestructuring.html b/typedoc/functions/isObjectDestructuring.html index 1348565aca4..5111933ea40 100644 --- a/typedoc/functions/isObjectDestructuring.html +++ b/typedoc/functions/isObjectDestructuring.html @@ -1 +1 @@ -isObjectDestructuring | SonarJS linter helper functions

    Function isObjectDestructuring

    • isObjectDestructuring(node): node is VariableDeclarator & {
          id: ObjectPattern;
      } | AssignmentExpression & {
          left: ObjectPattern;
      }

    • Parameters

      • node: Node

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

    Settings

    +isObjectDestructuring | SonarJS linter helper functions

    Function isObjectDestructuring

    • isObjectDestructuring(node): node is VariableDeclarator & {
          id: ObjectPattern;
      } | AssignmentExpression & {
          left: ObjectPattern;
      }

    • Parameters

      • node: Node

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

    Settings

    diff --git a/typedoc/functions/isObjectType.html b/typedoc/functions/isObjectType.html index 1e77f9a0d04..7d1c32c6761 100644 --- a/typedoc/functions/isObjectType.html +++ b/typedoc/functions/isObjectType.html @@ -1 +1 @@ -isObjectType | SonarJS linter helper functions

    Function isObjectType

    • isObjectType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isObjectType | SonarJS linter helper functions

    Function isObjectType

    • isObjectType(__namedParameters): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isPresentationTable.html b/typedoc/functions/isPresentationTable.html index d307bd99f6b..db1c0bb4a14 100644 --- a/typedoc/functions/isPresentationTable.html +++ b/typedoc/functions/isPresentationTable.html @@ -1 +1 @@ -isPresentationTable | SonarJS linter helper functions

    Function isPresentationTable

    • isPresentationTable(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    Settings

    +isPresentationTable | SonarJS linter helper functions

    Function isPresentationTable

    • isPresentationTable(context, node): boolean

    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isProperty.html b/typedoc/functions/isProperty.html index 15608a648f5..380623de847 100644 --- a/typedoc/functions/isProperty.html +++ b/typedoc/functions/isProperty.html @@ -1 +1 @@ -isProperty | SonarJS linter helper functions

    Function isProperty

    • isProperty(node): node is Property

    • Parameters

      • node: Node

      Returns node is Property

    Settings

    +isProperty | SonarJS linter helper functions

    Function isProperty

    • isProperty(node): node is Property

    • Parameters

      • node: Node

      Returns node is Property

    Settings

    diff --git a/typedoc/functions/isReferenceTo.html b/typedoc/functions/isReferenceTo.html index 69391cc81f5..67d83d788e8 100644 --- a/typedoc/functions/isReferenceTo.html +++ b/typedoc/functions/isReferenceTo.html @@ -1 +1 @@ -isReferenceTo | SonarJS linter helper functions

    Function isReferenceTo

    • isReferenceTo(ref, node): boolean

    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    Settings

    +isReferenceTo | SonarJS linter helper functions

    Function isReferenceTo

    • isReferenceTo(ref, node): boolean

    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isRegexLiteral.html b/typedoc/functions/isRegexLiteral.html index 4e12a153c5b..9fe6f86742c 100644 --- a/typedoc/functions/isRegexLiteral.html +++ b/typedoc/functions/isRegexLiteral.html @@ -1 +1 @@ -isRegexLiteral | SonarJS linter helper functions

    Function isRegexLiteral

    • isRegexLiteral(node): node is RegExpLiteral

    • Parameters

      • node: Node

      Returns node is RegExpLiteral

    Settings

    +isRegexLiteral | SonarJS linter helper functions

    Function isRegexLiteral

    • isRegexLiteral(node): node is RegExpLiteral

    • Parameters

      • node: Node

      Returns node is RegExpLiteral

    Settings

    diff --git a/typedoc/functions/isRequire.html b/typedoc/functions/isRequire.html index d8db43c363e..5162fdbc398 100644 --- a/typedoc/functions/isRequire.html +++ b/typedoc/functions/isRequire.html @@ -1 +1 @@ -isRequire | SonarJS linter helper functions

    Function isRequire

    • isRequire(node): node is CallExpression

    • Parameters

      Returns node is CallExpression

    Settings

    +isRequire | SonarJS linter helper functions

    Function isRequire

    • isRequire(node): node is CallExpression

    • Parameters

      Returns node is CallExpression

    Settings

    diff --git a/typedoc/functions/isRequireModule.html b/typedoc/functions/isRequireModule.html index 05b002b068c..acc73a592bd 100644 --- a/typedoc/functions/isRequireModule.html +++ b/typedoc/functions/isRequireModule.html @@ -1 +1 @@ -isRequireModule | SonarJS linter helper functions

    Function isRequireModule

    • isRequireModule(node, ...moduleNames): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isRequireModule | SonarJS linter helper functions

    Function isRequireModule

    • isRequireModule(node, ...moduleNames): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isRequiredParserServices.html b/typedoc/functions/isRequiredParserServices.html index 6ed2584c8cb..cbc42bea8a2 100644 --- a/typedoc/functions/isRequiredParserServices.html +++ b/typedoc/functions/isRequiredParserServices.html @@ -1 +1 @@ -isRequiredParserServices | SonarJS linter helper functions

    Function isRequiredParserServices

    • isRequiredParserServices(services): services is ParserServicesWithTypeInformation

    • Parameters

      • services: undefined | ParserServices

      Returns services is ParserServicesWithTypeInformation

    Settings

    +isRequiredParserServices | SonarJS linter helper functions

    Function isRequiredParserServices

    • isRequiredParserServices(services): services is ParserServicesWithTypeInformation

    • Parameters

      • services: undefined | ParserServices

      Returns services is ParserServicesWithTypeInformation

    Settings

    diff --git a/typedoc/functions/isRoot.html b/typedoc/functions/isRoot.html index 39549fa6dd4..2415deba51d 100644 --- a/typedoc/functions/isRoot.html +++ b/typedoc/functions/isRoot.html @@ -1 +1 @@ -isRoot | SonarJS linter helper functions

    Function isRoot

    • isRoot(file): boolean

    • Parameters

      • file: string

      Returns boolean

    Settings

    +isRoot | SonarJS linter helper functions

    Function isRoot

    • isRoot(file): boolean

    • Parameters

      • file: string

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isS3BucketConstructor.html b/typedoc/functions/isS3BucketConstructor.html index 5c2337d5c20..96d2c3664dd 100644 --- a/typedoc/functions/isS3BucketConstructor.html +++ b/typedoc/functions/isS3BucketConstructor.html @@ -1,4 +1,4 @@ isS3BucketConstructor | SonarJS linter helper functions

    Function isS3BucketConstructor

    • isS3BucketConstructor(context, node): boolean

    • 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isS3BucketDeploymentConstructor.html b/typedoc/functions/isS3BucketDeploymentConstructor.html index b74e16daa02..2b80ca7925b 100644 --- a/typedoc/functions/isS3BucketDeploymentConstructor.html +++ b/typedoc/functions/isS3BucketDeploymentConstructor.html @@ -1,4 +1,4 @@ isS3BucketDeploymentConstructor | SonarJS linter helper functions

    Function isS3BucketDeploymentConstructor

    • isS3BucketDeploymentConstructor(context, node): boolean

    • 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

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isSimpleRawString.html b/typedoc/functions/isSimpleRawString.html index ed8d2191582..41dbcd293b3 100644 --- a/typedoc/functions/isSimpleRawString.html +++ b/typedoc/functions/isSimpleRawString.html @@ -1 +1 @@ -isSimpleRawString | SonarJS linter helper functions

    Function isSimpleRawString

    • isSimpleRawString(node): node is TaggedTemplateExpression

    • Parameters

      • node: Node

      Returns node is TaggedTemplateExpression

    Settings

    +isSimpleRawString | SonarJS linter helper functions

    Function isSimpleRawString

    • isSimpleRawString(node): node is TaggedTemplateExpression

    • Parameters

      • node: Node

      Returns node is TaggedTemplateExpression

    Settings

    diff --git a/typedoc/functions/isStaticTemplateLiteral.html b/typedoc/functions/isStaticTemplateLiteral.html index 84f460db7fa..f87247e657b 100644 --- a/typedoc/functions/isStaticTemplateLiteral.html +++ b/typedoc/functions/isStaticTemplateLiteral.html @@ -1 +1 @@ -isStaticTemplateLiteral | SonarJS linter helper functions

    Function isStaticTemplateLiteral

    • isStaticTemplateLiteral(node): node is TemplateLiteral

    • Parameters

      • node: Node

      Returns node is TemplateLiteral

    Settings

    +isStaticTemplateLiteral | SonarJS linter helper functions

    Function isStaticTemplateLiteral

    • isStaticTemplateLiteral(node): node is TemplateLiteral

    • Parameters

      • node: Node

      Returns node is TemplateLiteral

    Settings

    diff --git a/typedoc/functions/isString.html b/typedoc/functions/isString.html index 2c8c6366d11..0019c751cab 100644 --- a/typedoc/functions/isString.html +++ b/typedoc/functions/isString.html @@ -1 +1 @@ -isString | SonarJS linter helper functions

    Function isString

    • isString(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isString | SonarJS linter helper functions

    Function isString

    • isString(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isStringArray.html b/typedoc/functions/isStringArray.html index 4a937c4e0d5..a2de52c0d0b 100644 --- a/typedoc/functions/isStringArray.html +++ b/typedoc/functions/isStringArray.html @@ -1,4 +1,4 @@ isStringArray | SonarJS linter helper functions

    Function isStringArray

    • isStringArray(type, services): boolean

    • 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

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isStringLiteral.html b/typedoc/functions/isStringLiteral.html index 96724ef737c..bdd4935837d 100644 --- a/typedoc/functions/isStringLiteral.html +++ b/typedoc/functions/isStringLiteral.html @@ -1 +1 @@ -isStringLiteral | SonarJS linter helper functions

    Function isStringLiteral

    Settings

    +isStringLiteral | SonarJS linter helper functions

    Function isStringLiteral

    Settings

    diff --git a/typedoc/functions/isStringType.html b/typedoc/functions/isStringType.html index 9f7395a6623..9f334e59c92 100644 --- a/typedoc/functions/isStringType.html +++ b/typedoc/functions/isStringType.html @@ -1 +1 @@ -isStringType | SonarJS linter helper functions

    Function isStringType

    • isStringType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isStringType | SonarJS linter helper functions

    Function isStringType

    • isStringType(type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isSupported.html b/typedoc/functions/isSupported.html index 172c1d19dd3..e9117039a12 100644 --- a/typedoc/functions/isSupported.html +++ b/typedoc/functions/isSupported.html @@ -1,3 +1,3 @@ isSupported | SonarJS linter helper functions

    Function isSupported

    • isSupported(dirname, minVersions): boolean

    • Checks if context where the filename is located supports the provided minimum versions.

      -

      Parameters

      • dirname: string
      • minVersions: MinimumVersions

      Returns boolean

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isThenable.html b/typedoc/functions/isThenable.html index 1bdfc14ffac..6949c636219 100644 --- a/typedoc/functions/isThenable.html +++ b/typedoc/functions/isThenable.html @@ -1 +1 @@ -isThenable | SonarJS linter helper functions

    Function isThenable

    • isThenable(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isThenable | SonarJS linter helper functions

    Function isThenable

    • isThenable(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isThisExpression.html b/typedoc/functions/isThisExpression.html index 066abe8901e..dad4a07d4f8 100644 --- a/typedoc/functions/isThisExpression.html +++ b/typedoc/functions/isThisExpression.html @@ -1 +1 @@ -isThisExpression | SonarJS linter helper functions

    Function isThisExpression

    • isThisExpression(node): node is ThisExpression

    • Parameters

      • node: Node

      Returns node is ThisExpression

    Settings

    +isThisExpression | SonarJS linter helper functions

    Function isThisExpression

    • isThisExpression(node): node is ThisExpression

    • Parameters

      • node: Node

      Returns node is ThisExpression

    Settings

    diff --git a/typedoc/functions/isThrowStatement.html b/typedoc/functions/isThrowStatement.html index 07f210fcc4b..e365da6a1cc 100644 --- a/typedoc/functions/isThrowStatement.html +++ b/typedoc/functions/isThrowStatement.html @@ -1 +1 @@ -isThrowStatement | SonarJS linter helper functions

    Function isThrowStatement

    • isThrowStatement(node): node is ThrowStatement

    • Parameters

      • node: undefined | Node

      Returns node is ThrowStatement

    Settings

    +isThrowStatement | SonarJS linter helper functions

    Function isThrowStatement

    • isThrowStatement(node): node is ThrowStatement

    • Parameters

      • node: undefined | Node

      Returns node is ThrowStatement

    Settings

    diff --git a/typedoc/functions/isTypeAlias.html b/typedoc/functions/isTypeAlias.html index ade7c800e99..30fa45f4100 100644 --- a/typedoc/functions/isTypeAlias.html +++ b/typedoc/functions/isTypeAlias.html @@ -1,4 +1,4 @@ isTypeAlias | SonarJS linter helper functions

    Function isTypeAlias

    • isTypeAlias(node, context): undefined | boolean

    • 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

    Settings

    +

    Returns undefined | boolean

    Settings

    diff --git a/typedoc/functions/isTypedArray.html b/typedoc/functions/isTypedArray.html index 199048a02db..ed871d08781 100644 --- a/typedoc/functions/isTypedArray.html +++ b/typedoc/functions/isTypedArray.html @@ -1,2 +1,2 @@ isTypedArray | SonarJS linter helper functions

    Function isTypedArray

    • isTypedArray(node, services): boolean

    • Checks if the provided node is a JS typed array like "BigInt64Array". See TYPED_ARRAY_TYPES

      -

      Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isUnaryExpression.html b/typedoc/functions/isUnaryExpression.html index c0d01cbf3f2..975f496fb64 100644 --- a/typedoc/functions/isUnaryExpression.html +++ b/typedoc/functions/isUnaryExpression.html @@ -1 +1 @@ -isUnaryExpression | SonarJS linter helper functions

    Function isUnaryExpression

    • isUnaryExpression(node): node is UnaryExpression

    • Parameters

      • node: undefined | Node

      Returns node is UnaryExpression

    Settings

    +isUnaryExpression | SonarJS linter helper functions

    Function isUnaryExpression

    • isUnaryExpression(node): node is UnaryExpression

    • Parameters

      • node: undefined | Node

      Returns node is UnaryExpression

    Settings

    diff --git a/typedoc/functions/isUndefined.html b/typedoc/functions/isUndefined.html index fa201253ecd..d0b0d89b7d0 100644 --- a/typedoc/functions/isUndefined.html +++ b/typedoc/functions/isUndefined.html @@ -1 +1 @@ -isUndefined | SonarJS linter helper functions

    Function isUndefined

    • isUndefined(node): boolean

    • Parameters

      Returns boolean

    Settings

    +isUndefined | SonarJS linter helper functions

    Function isUndefined

    • isUndefined(node): boolean

    • Parameters

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isUndefinedOrNull.html b/typedoc/functions/isUndefinedOrNull.html index 29e7185b65b..0e934c2f61c 100644 --- a/typedoc/functions/isUndefinedOrNull.html +++ b/typedoc/functions/isUndefinedOrNull.html @@ -1 +1 @@ -isUndefinedOrNull | SonarJS linter helper functions

    Function isUndefinedOrNull

    • isUndefinedOrNull(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isUndefinedOrNull | SonarJS linter helper functions

    Function isUndefinedOrNull

    • isUndefinedOrNull(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isUnion.html b/typedoc/functions/isUnion.html index 257a2d4d8c8..555331107e2 100644 --- a/typedoc/functions/isUnion.html +++ b/typedoc/functions/isUnion.html @@ -1 +1 @@ -isUnion | SonarJS linter helper functions

    Function isUnion

    • isUnion(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isUnion | SonarJS linter helper functions

    Function isUnion

    • isUnion(node, services): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isUnresolved.html b/typedoc/functions/isUnresolved.html index bfe045c94c8..87e4b48a4c8 100644 --- a/typedoc/functions/isUnresolved.html +++ b/typedoc/functions/isUnresolved.html @@ -6,4 +6,4 @@

    Parameters

    Returns boolean

    Settings

    +

    Returns boolean

    Settings

    diff --git a/typedoc/functions/isVariableDeclaration.html b/typedoc/functions/isVariableDeclaration.html index e54c439d737..cf3681fac76 100644 --- a/typedoc/functions/isVariableDeclaration.html +++ b/typedoc/functions/isVariableDeclaration.html @@ -1 +1 @@ -isVariableDeclaration | SonarJS linter helper functions

    Function isVariableDeclaration

    • isVariableDeclaration(node): node is VariableDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is VariableDeclaration

    Settings

    +isVariableDeclaration | SonarJS linter helper functions

    Function isVariableDeclaration

    • isVariableDeclaration(node): node is VariableDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is VariableDeclaration

    Settings

    diff --git a/typedoc/functions/last.html b/typedoc/functions/last.html index 7f08c7e378d..170e6e9b86d 100644 --- a/typedoc/functions/last.html +++ b/typedoc/functions/last.html @@ -1 +1 @@ -last | SonarJS linter helper functions

    Function last

    Settings

    +last | SonarJS linter helper functions

    Function last

    Settings

    diff --git a/typedoc/functions/localAncestorsChain.html b/typedoc/functions/localAncestorsChain.html index 8a02b715786..590b4d90b13 100644 --- a/typedoc/functions/localAncestorsChain.html +++ b/typedoc/functions/localAncestorsChain.html @@ -1 +1 @@ -localAncestorsChain | SonarJS linter helper functions

    Function localAncestorsChain

    • localAncestorsChain(node): Node[]

    • Parameters

      • node: Node

      Returns Node[]

    Settings

    +localAncestorsChain | SonarJS linter helper functions

    Function localAncestorsChain

    • localAncestorsChain(node): Node[]

    • Parameters

      • node: Node

      Returns Node[]

    Settings

    diff --git a/typedoc/functions/lva.html b/typedoc/functions/lva.html index 3cabf9b9185..a1dc787d16c 100644 --- a/typedoc/functions/lva.html +++ b/typedoc/functions/lva.html @@ -1 +1 @@ -lva | SonarJS linter helper functions

    Function lva

    • lva(liveVariablesMap): void

    • Parameters

      Returns void

    Settings

    +lva | SonarJS linter helper functions

    Function lva

    • lva(liveVariablesMap): void

    • Parameters

      Returns void

    Settings

    diff --git a/typedoc/functions/mergeRules.html b/typedoc/functions/mergeRules.html index 9f5ec3f0249..33ca3a7ccd2 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/normalizeFQN.html b/typedoc/functions/normalizeFQN.html index 4e86878217a..10d1ef79fc2 100644 --- a/typedoc/functions/normalizeFQN.html +++ b/typedoc/functions/normalizeFQN.html @@ -1 +1 @@ -normalizeFQN | SonarJS linter helper functions

    Function normalizeFQN

    • normalizeFQN(fqn?): undefined | string

    • Parameters

      • Optionalfqn: null | string

      Returns undefined | string

    Settings

    +normalizeFQN | SonarJS linter helper functions

    Function normalizeFQN

    • normalizeFQN(fqn?): undefined | string

    • Parameters

      • Optionalfqn: null | string

      Returns undefined | string

    Settings

    diff --git a/typedoc/functions/reachingDefinitions-1.html b/typedoc/functions/reachingDefinitions-1.html index 6390028081f..e3879166407 100644 --- a/typedoc/functions/reachingDefinitions-1.html +++ b/typedoc/functions/reachingDefinitions-1.html @@ -1 +1 @@ -reachingDefinitions | SonarJS linter helper functions

    Function reachingDefinitions

    Settings

    +reachingDefinitions | SonarJS linter helper functions

    Function reachingDefinitions

    Settings

    diff --git a/typedoc/functions/readFileSync.html b/typedoc/functions/readFileSync.html index 734ef426328..4f45ed708ff 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/reduceTo.html b/typedoc/functions/reduceTo.html index d223841f244..9f204525ce0 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

    Settings

    +

    Returns estree.Node

    Settings

    diff --git a/typedoc/functions/reduceToIdentifier.html b/typedoc/functions/reduceToIdentifier.html index c4e125ba9d1..7d2274994f6 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

    Settings

    +

    Returns estree.Node

    Settings

    diff --git a/typedoc/functions/removeNodeWithLeadingWhitespaces.html b/typedoc/functions/removeNodeWithLeadingWhitespaces.html index 72914faf0fd..3d105cefccb 100644 --- a/typedoc/functions/removeNodeWithLeadingWhitespaces.html +++ b/typedoc/functions/removeNodeWithLeadingWhitespaces.html @@ -1 +1 @@ -removeNodeWithLeadingWhitespaces | SonarJS linter helper functions

    Function removeNodeWithLeadingWhitespaces

    • removeNodeWithLeadingWhitespaces(context, node, fixer, removeUntil?): Fix

    • Parameters

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

      Returns Fix

    Settings

    +removeNodeWithLeadingWhitespaces | SonarJS linter helper functions

    Function removeNodeWithLeadingWhitespaces

    • removeNodeWithLeadingWhitespaces(context, node, fixer, removeUntil?): Fix

    • Parameters

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

      Returns Fix

    Settings

    diff --git a/typedoc/functions/report.html b/typedoc/functions/report.html index 740cf3fba44..1652cfd0927 100644 --- a/typedoc/functions/report.html +++ b/typedoc/functions/report.html @@ -1,4 +1,4 @@ report | SonarJS linter helper functions

    Function report

    • report(context, reportDescriptor, secondaryLocations?, cost?): void

    • 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

    Settings

    +

    Parameters

    Returns void

    Settings

    diff --git a/typedoc/functions/resolveAssignedValues.html b/typedoc/functions/resolveAssignedValues.html index 6646b4efd0c..de315066b15 100644 --- a/typedoc/functions/resolveAssignedValues.html +++ b/typedoc/functions/resolveAssignedValues.html @@ -1 +1 @@ -resolveAssignedValues | SonarJS linter helper functions

    Function resolveAssignedValues

    • resolveAssignedValues(lhsVariable, writeExpr, assignedValuesMap, scope): Values

    • Parameters

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

      Returns Values

    Settings

    +resolveAssignedValues | SonarJS linter helper functions

    Function resolveAssignedValues

    • resolveAssignedValues(lhsVariable, writeExpr, assignedValuesMap, scope): Values

    • Parameters

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

      Returns Values

    Settings

    diff --git a/typedoc/functions/resolveFromFunctionReference.html b/typedoc/functions/resolveFromFunctionReference.html index 5bae669a8d5..0bf5c972dd1 100644 --- a/typedoc/functions/resolveFromFunctionReference.html +++ b/typedoc/functions/resolveFromFunctionReference.html @@ -1 +1 @@ -resolveFromFunctionReference | SonarJS linter helper functions

    Function resolveFromFunctionReference

    • resolveFromFunctionReference(context, functionIdentifier): null | FunctionExpression | FunctionDeclaration

    • Parameters

      • context: RuleContext
      • functionIdentifier: Identifier

      Returns null | FunctionExpression | FunctionDeclaration

    Settings

    +resolveFromFunctionReference | SonarJS linter helper functions

    Function resolveFromFunctionReference

    • resolveFromFunctionReference(context, functionIdentifier): null | FunctionExpression | FunctionDeclaration

    • Parameters

      • context: RuleContext
      • functionIdentifier: Identifier

      Returns null | FunctionExpression | FunctionDeclaration

    Settings

    diff --git a/typedoc/functions/resolveFunction.html b/typedoc/functions/resolveFunction.html index c02963ba4fa..df1ce950682 100644 --- a/typedoc/functions/resolveFunction.html +++ b/typedoc/functions/resolveFunction.html @@ -1 +1 @@ -resolveFunction | SonarJS linter helper functions

    Function resolveFunction

    • resolveFunction(context, node): estree.Function | null

    • Parameters

      • context: RuleContext
      • node: Node

      Returns estree.Function | null

    Settings

    +resolveFunction | SonarJS linter helper functions

    Function resolveFunction

    • resolveFunction(context, node): estree.Function | null

    • Parameters

      • context: RuleContext
      • node: Node

      Returns estree.Function | null

    Settings

    diff --git a/typedoc/functions/resolveIdentifiers.html b/typedoc/functions/resolveIdentifiers.html index 59c085f475f..b407d5dd858 100644 --- a/typedoc/functions/resolveIdentifiers.html +++ b/typedoc/functions/resolveIdentifiers.html @@ -1 +1 @@ -resolveIdentifiers | SonarJS linter helper functions

    Function resolveIdentifiers

    • resolveIdentifiers(node, acceptShorthand?): TSESTree.Identifier[]

    • Parameters

      • node: Node
      • acceptShorthand: boolean = false

      Returns TSESTree.Identifier[]

    Settings

    +resolveIdentifiers | SonarJS linter helper functions

    Function resolveIdentifiers

    • resolveIdentifiers(node, acceptShorthand?): TSESTree.Identifier[]

    • Parameters

      • node: Node
      • acceptShorthand: boolean = false

      Returns TSESTree.Identifier[]

    Settings

    diff --git a/typedoc/functions/searchFiles.html b/typedoc/functions/searchFiles.html index b821af3a768..76c45036bd3 100644 --- a/typedoc/functions/searchFiles.html +++ b/typedoc/functions/searchFiles.html @@ -4,4 +4,4 @@

    Parameters

    Returns FilesByFilter

    Settings

    +

    Returns FilesByFilter

    Settings

    diff --git a/typedoc/functions/stripBOM.html b/typedoc/functions/stripBOM.html index 372d4256a42..2af0edad2d1 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/takeWithoutBreak.html b/typedoc/functions/takeWithoutBreak.html index 7fe14d741f3..0ac60401ddf 100644 --- a/typedoc/functions/takeWithoutBreak.html +++ b/typedoc/functions/takeWithoutBreak.html @@ -1,2 +1,2 @@ takeWithoutBreak | SonarJS linter helper functions

    Function takeWithoutBreak

    • takeWithoutBreak(nodes): Statement[]

    • Excludes the break statement from the list

      -

      Parameters

      • nodes: Statement[]

      Returns Statement[]

    Settings

    +

    Parameters

    Returns Statement[]

    Settings

    diff --git a/typedoc/functions/toEncodedMessage.html b/typedoc/functions/toEncodedMessage.html index bc43d47834e..a92f6ff9f18 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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/functions/toSecondaryLocation.html b/typedoc/functions/toSecondaryLocation.html index 0f222eaa862..357a782a745 100644 --- a/typedoc/functions/toSecondaryLocation.html +++ b/typedoc/functions/toSecondaryLocation.html @@ -1 +1 @@ -toSecondaryLocation | SonarJS linter helper functions

    Function toSecondaryLocation

    Settings

    +toSecondaryLocation | SonarJS linter helper functions

    Function toSecondaryLocation

    Settings

    diff --git a/typedoc/functions/toUnixPath.html b/typedoc/functions/toUnixPath.html index 6723c8fea62..9fbac7a7a5d 100644 --- a/typedoc/functions/toUnixPath.html +++ b/typedoc/functions/toUnixPath.html @@ -1,4 +1,4 @@ toUnixPath | SonarJS linter helper functions

    Function toUnixPath

    • toUnixPath(path): string

    • Converts a path to Unix format

      Parameters

      • path: string

        the path to convert

      Returns string

      the converted path

      -

    Settings

    +

    Settings

    diff --git a/typedoc/interfaces/EncodedMessage.html b/typedoc/interfaces/EncodedMessage.html index 3e006de4840..3d6edaeac2e 100644 --- a/typedoc/interfaces/EncodedMessage.html +++ b/typedoc/interfaces/EncodedMessage.html @@ -1,4 +1,4 @@ -EncodedMessage | SonarJS linter helper functions

    Interface EncodedMessage

    interface EncodedMessage {
        cost?: number;
        message: string;
        secondaryLocations: IssueLocation[];
    }

    Properties

    cost? +EncodedMessage | SonarJS linter helper functions

    Interface EncodedMessage

    interface EncodedMessage {
        cost?: number;
        message: string;
        secondaryLocations: IssueLocation[];
    }

    Properties

    cost? message secondaryLocations -

    Properties

    Optionalcost

    cost?: number

    message

    message: string

    secondaryLocations

    secondaryLocations: IssueLocation[]

    Settings

    On This Page

    Properties
    +

    Properties

    Optionalcost

    cost?: number

    message

    message: string

    secondaryLocations

    secondaryLocations: IssueLocation[]

    Settings

    On This Page

    Properties
    diff --git a/typedoc/interfaces/File.html b/typedoc/interfaces/File.html index a8d8acaac15..51f20d8b056 100644 --- a/typedoc/interfaces/File.html +++ b/typedoc/interfaces/File.html @@ -1,3 +1,3 @@ -File | SonarJS linter helper functions

    Interface File<T>

    interface File<T> {
        contents: T;
        filename: string;
    }

    Type Parameters

    • T

    Properties

    contents +File | SonarJS linter helper functions

    Interface File<T>

    interface File<T> {
        contents: T;
        filename: string;
    }

    Type Parameters

    • T

    Properties

    contents filename -

    Properties

    contents

    contents: T

    filename

    filename: string

    Settings

    On This Page

    Properties
    +

    Properties

    contents

    contents: T

    filename

    filename: string

    Settings

    On This Page

    Properties
    diff --git a/typedoc/interfaces/IssueLocation.html b/typedoc/interfaces/IssueLocation.html index 89cd4682c2a..f73cdf2646f 100644 --- a/typedoc/interfaces/IssueLocation.html +++ b/typedoc/interfaces/IssueLocation.html @@ -1,6 +1,6 @@ -IssueLocation | SonarJS linter helper functions

    Interface IssueLocation

    interface IssueLocation {
        column: number;
        endColumn: number;
        endLine: number;
        line: number;
        message?: string;
    }

    Properties

    column +IssueLocation | SonarJS linter helper functions

    Interface IssueLocation

    interface IssueLocation {
        column: number;
        endColumn: number;
        endLine: number;
        line: number;
        message?: string;
    }

    Properties

    column endColumn endLine line message? -

    Properties

    column

    column: number

    endColumn

    endColumn: number

    endLine

    endLine: number

    line

    line: number

    Optionalmessage

    message?: string

    Settings

    On This Page

    Properties
    +

    Properties

    column

    column: number

    endColumn

    endColumn: number

    endLine

    endLine: number

    line

    line: number

    Optionalmessage

    message?: string

    Settings

    On This Page

    Properties
    diff --git a/typedoc/interfaces/Mocha.TestCase.html b/typedoc/interfaces/Mocha.TestCase.html index 1b5bc18fb54..a1492638635 100644 --- a/typedoc/interfaces/Mocha.TestCase.html +++ b/typedoc/interfaces/Mocha.TestCase.html @@ -1,3 +1,3 @@ -TestCase | SonarJS linter helper functions

    Interface TestCase

    interface TestCase {
        callback: Function;
        node: Node;
    }

    Properties

    callback +TestCase | SonarJS linter helper functions

    Interface TestCase

    interface TestCase {
        callback: Function;
        node: Node;
    }

    Properties

    callback node -

    Properties

    callback

    callback: Function

    node

    node: Node

    Settings

    On This Page

    Properties
    +

    Properties

    callback

    callback: Function

    node

    node: Node

    Settings

    On This Page

    Properties
    diff --git a/typedoc/interfaces/PolicyCheckerOptions.html b/typedoc/interfaces/PolicyCheckerOptions.html index f76b248cdd4..7c18544564f 100644 --- a/typedoc/interfaces/PolicyCheckerOptions.html +++ b/typedoc/interfaces/PolicyCheckerOptions.html @@ -1,6 +1,6 @@ -PolicyCheckerOptions | SonarJS linter helper functions

    Interface PolicyCheckerOptions

    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

    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 conditions effect principals resources -

    Properties

    actions

    actions: {
        anyValues?: string[];
        property: string;
    }

    conditions

    conditions: {
        property: string;
    }

    effect

    effect: {
        allowValue: string;
        property: string;
        type: "string" | "FullyQualifiedName";
    }

    principals

    principals: {
        anyValues?: string[];
        property: string;
        type: "FullyQualifiedName" | "json";
    }

    resources

    resources: {
        property: string;
    }

    Settings

    On This Page

    Properties
    +

    Properties

    actions

    actions: {
        anyValues?: string[];
        property: string;
    }

    conditions

    conditions: {
        property: string;
    }

    effect

    effect: {
        allowValue: string;
        property: string;
        type: "string" | "FullyQualifiedName";
    }

    principals

    principals: {
        anyValues?: string[];
        property: string;
        type: "FullyQualifiedName" | "json";
    }

    resources

    resources: {
        property: string;
    }

    Settings

    On This Page

    Properties
    diff --git a/typedoc/interfaces/ReferenceLike.html b/typedoc/interfaces/ReferenceLike.html index af551d7ea9c..49aa678e94b 100644 --- a/typedoc/interfaces/ReferenceLike.html +++ b/typedoc/interfaces/ReferenceLike.html @@ -1,4 +1,4 @@ -ReferenceLike | SonarJS linter helper functions

    Interface ReferenceLike

    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

    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 identifier init resolved @@ -8,4 +8,4 @@ isReadWrite isWrite isWriteOnly -

    Properties

    from

    from: Scope

    identifier

    identifier: JSXIdentifier | Identifier

    init

    init: boolean

    resolved

    resolved: null | Variable

    writeExpr

    writeExpr: null | Node

    Methods

    isRead

    • isRead(): boolean

    • Returns boolean

    isReadOnly

    • isReadOnly(): boolean

    • Returns boolean

    isReadWrite

    • isReadWrite(): boolean

    • Returns boolean

    isWrite

    • isWrite(): boolean

    • Returns boolean

    isWriteOnly

    • isWriteOnly(): boolean

    • Returns boolean

    Settings

    On This Page

    Properties
    Methods
    +

    Properties

    from

    from: Scope

    identifier

    identifier: JSXIdentifier | Identifier

    init

    init: boolean

    resolved

    resolved: null | Variable

    writeExpr

    writeExpr: null | Node

    Methods

    isRead

    • isRead(): boolean

    • Returns boolean

    isReadOnly

    • isReadOnly(): boolean

    • Returns boolean

    isReadWrite

    • isReadWrite(): boolean

    • Returns boolean

    isWrite

    • isWrite(): boolean

    • Returns boolean

    isWriteOnly

    • isWriteOnly(): boolean

    • Returns boolean

    Settings

    On This Page

    Properties
    Methods
    diff --git a/typedoc/modules/Chai.html b/typedoc/modules/Chai.html index abdbb338325..13d1aaf9a87 100644 --- a/typedoc/modules/Chai.html +++ b/typedoc/modules/Chai.html @@ -1,3 +1,3 @@ -Chai | SonarJS linter helper functions

    Namespace Chai

    Index

    Functions

    isAssertion +Chai | SonarJS linter helper functions

    Namespace Chai

    Index

    Functions

    isAssertion isImported

    Settings

    diff --git a/typedoc/modules/Express.html b/typedoc/modules/Express.html index fd844d1e3a2..dec1bf486a7 100644 --- a/typedoc/modules/Express.html +++ b/typedoc/modules/Express.html @@ -1,5 +1,5 @@ Express | SonarJS linter helper functions

    Namespace Express

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

    -

    Index

    Functions

    attemptFindAppInjection +

    Index

    Functions

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

    Namespace Mocha

    Index

    Interfaces

    TestCase +Mocha | SonarJS linter helper functions

    Namespace Mocha

    Index

    Interfaces

    TestCase

    Functions

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

    Namespace Sinon

    Index

    Functions

    isAssertion +Sinon | SonarJS linter helper functions

    Namespace Sinon

    Index

    Functions

    isAssertion isImported

    Settings

    diff --git a/typedoc/modules/Vitest.html b/typedoc/modules/Vitest.html index 03bc45da9a7..3455c1e4ebf 100644 --- a/typedoc/modules/Vitest.html +++ b/typedoc/modules/Vitest.html @@ -1,3 +1,3 @@ -Vitest | SonarJS linter helper functions

    Namespace Vitest

    Index

    Functions

    isAssertion +Vitest | SonarJS linter helper functions

    Namespace Vitest

    Index

    Functions

    isAssertion isImported

    Settings

    diff --git a/typedoc/types/AwsCdkCallback.html b/typedoc/types/AwsCdkCallback.html index 4531ef56381..e99fbd600ad 100644 --- a/typedoc/types/AwsCdkCallback.html +++ b/typedoc/types/AwsCdkCallback.html @@ -1 +1 @@ -AwsCdkCallback | SonarJS linter helper functions

    Type Alias AwsCdkCallback

    AwsCdkCallback: {
        functionName?: string;
        methods?: string[];
        callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void;
        newExpression?(expr: NewExpression, ctx: RuleContext): void;
    }

    Settings

    +AwsCdkCallback | SonarJS linter helper functions

    Type Alias AwsCdkCallback

    AwsCdkCallback: {
        functionName?: string;
        methods?: string[];
        callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void;
        newExpression?(expr: NewExpression, ctx: RuleContext): void;
    }

    Settings

    diff --git a/typedoc/types/AwsCdkConsumer.html b/typedoc/types/AwsCdkConsumer.html index 6132f0beb70..0db6986d29c 100644 --- a/typedoc/types/AwsCdkConsumer.html +++ b/typedoc/types/AwsCdkConsumer.html @@ -1 +1 @@ -AwsCdkConsumer | SonarJS linter helper functions

    Type Alias AwsCdkConsumer

    AwsCdkConsumer: ((expr: estree.NewExpression, ctx: Rule.RuleContext) => void) | AwsCdkCallback

    Settings

    +AwsCdkConsumer | SonarJS linter helper functions

    Type Alias AwsCdkConsumer

    AwsCdkConsumer: ((expr: estree.NewExpression, ctx: Rule.RuleContext) => void) | AwsCdkCallback

    Settings

    diff --git a/typedoc/types/AwsCdkConsumerMap.html b/typedoc/types/AwsCdkConsumerMap.html index e94450b51a2..ed4d040df83 100644 --- a/typedoc/types/AwsCdkConsumerMap.html +++ b/typedoc/types/AwsCdkConsumerMap.html @@ -1 +1 @@ -AwsCdkConsumerMap | SonarJS linter helper functions

    Type Alias AwsCdkConsumerMap

    AwsCdkConsumerMap: {
        [key: FullyQualifiedName]: AwsCdkConsumer;
    }

    Settings

    +AwsCdkConsumerMap | SonarJS linter helper functions

    Type Alias AwsCdkConsumerMap

    AwsCdkConsumerMap: {
        [key: FullyQualifiedName]: AwsCdkConsumer;
    }

    Settings

    diff --git a/typedoc/types/ContextOverrider.html b/typedoc/types/ContextOverrider.html index ecd42ee61be..ec8212982bf 100644 --- a/typedoc/types/ContextOverrider.html +++ b/typedoc/types/ContextOverrider.html @@ -1 +1 @@ -ContextOverrider | SonarJS linter helper functions

    Type Alias ContextOverrider

    ContextOverrider: ((context: Rule.RuleContext, onReport: ReportOverrider) => Rule.RuleContext)

    Settings

    +ContextOverrider | SonarJS linter helper functions

    Type Alias ContextOverrider

    ContextOverrider: ((context: Rule.RuleContext, onReport: ReportOverrider) => Rule.RuleContext)

    Settings

    diff --git a/typedoc/types/FullyQualifiedName.html b/typedoc/types/FullyQualifiedName.html index f129fc2e760..722ff1b0abd 100644 --- a/typedoc/types/FullyQualifiedName.html +++ b/typedoc/types/FullyQualifiedName.html @@ -1,2 +1,2 @@ FullyQualifiedName | SonarJS linter helper functions

    Type Alias FullyQualifiedName

    FullyQualifiedName: string

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

    -

    Settings

    +

    Settings

    diff --git a/typedoc/types/FunctionNodeType.html b/typedoc/types/FunctionNodeType.html index 49e12e0a3f9..800611d5d1b 100644 --- a/typedoc/types/FunctionNodeType.html +++ b/typedoc/types/FunctionNodeType.html @@ -1 +1 @@ -FunctionNodeType | SonarJS linter helper functions

    Type Alias FunctionNodeType

    FunctionNodeType: estree.FunctionDeclaration | estree.FunctionExpression | estree.ArrowFunctionExpression

    Settings

    +FunctionNodeType | SonarJS linter helper functions

    Type Alias FunctionNodeType

    FunctionNodeType: estree.FunctionDeclaration | estree.FunctionExpression | estree.ArrowFunctionExpression

    Settings

    diff --git a/typedoc/types/LocationHolder.html b/typedoc/types/LocationHolder.html index b06060d3c47..4cbb446ac82 100644 --- a/typedoc/types/LocationHolder.html +++ b/typedoc/types/LocationHolder.html @@ -1 +1 @@ -LocationHolder | SonarJS linter helper functions

    Type Alias LocationHolder

    LocationHolder:
        | AST.Token
        | TSESTree.Node
        | estree.Node
        | {
            loc: AST.SourceLocation;
        }

    Settings

    +LocationHolder | SonarJS linter helper functions

    Type Alias LocationHolder

    LocationHolder:
        | AST.Token
        | TSESTree.Node
        | estree.Node
        | {
            loc: AST.SourceLocation;
        }

    Settings

    diff --git a/typedoc/types/LoopLike.html b/typedoc/types/LoopLike.html index caea51cb5f9..8b294e13cfc 100644 --- a/typedoc/types/LoopLike.html +++ b/typedoc/types/LoopLike.html @@ -1 +1 @@ -LoopLike | SonarJS linter helper functions

    Type Alias LoopLike

    LoopLike:
        | estree.WhileStatement
        | estree.DoWhileStatement
        | estree.ForStatement
        | estree.ForOfStatement
        | estree.ForInStatement

    Settings

    +LoopLike | SonarJS linter helper functions

    Type Alias LoopLike

    LoopLike:
        | estree.WhileStatement
        | estree.DoWhileStatement
        | estree.ForStatement
        | estree.ForOfStatement
        | estree.ForInStatement

    Settings

    diff --git a/typedoc/types/Node.html b/typedoc/types/Node.html index d6d4d33af9d..c0c915b05c1 100644 --- a/typedoc/types/Node.html +++ b/typedoc/types/Node.html @@ -1 +1 @@ -Node | SonarJS linter helper functions

    Type Alias Node

    Node: estree.Node | TSESTree.Node

    Settings

    +Node | SonarJS linter helper functions

    Type Alias Node

    Node: estree.Node | TSESTree.Node

    Settings

    diff --git a/typedoc/types/ReportOverrider.html b/typedoc/types/ReportOverrider.html index aff2893e628..3e9a8b04d71 100644 --- a/typedoc/types/ReportOverrider.html +++ b/typedoc/types/ReportOverrider.html @@ -1 +1 @@ -ReportOverrider | SonarJS linter helper functions

    Type Alias ReportOverrider

    ReportOverrider: ((context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor) => void)

    Settings

    +ReportOverrider | SonarJS linter helper functions

    Type Alias ReportOverrider

    ReportOverrider: ((context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor) => void)

    Settings

    diff --git a/typedoc/types/RequiredParserServices.html b/typedoc/types/RequiredParserServices.html index b94e68a0806..cf159ec0d71 100644 --- a/typedoc/types/RequiredParserServices.html +++ b/typedoc/types/RequiredParserServices.html @@ -1 +1 @@ -RequiredParserServices | SonarJS linter helper functions

    Type Alias RequiredParserServices

    RequiredParserServices: ParserServicesWithTypeInformation

    Settings

    +RequiredParserServices | SonarJS linter helper functions

    Type Alias RequiredParserServices

    RequiredParserServices: ParserServicesWithTypeInformation

    Settings

    diff --git a/typedoc/types/RuleContext.html b/typedoc/types/RuleContext.html index 5a56ed8d1e4..2a44f844ef5 100644 --- a/typedoc/types/RuleContext.html +++ b/typedoc/types/RuleContext.html @@ -1 +1 @@ -RuleContext | SonarJS linter helper functions

    Type Alias RuleContext

    RuleContext: TSESLint.RuleContext<string, string[]>

    Settings

    +RuleContext | SonarJS linter helper functions

    Type Alias RuleContext

    RuleContext: TSESLint.RuleContext<string, string[]>

    Settings

    diff --git a/typedoc/types/StringLiteral.html b/typedoc/types/StringLiteral.html index 98171efbd2c..23fac7b8701 100644 --- a/typedoc/types/StringLiteral.html +++ b/typedoc/types/StringLiteral.html @@ -1 +1 @@ -StringLiteral | SonarJS linter helper functions

    Type Alias StringLiteral

    StringLiteral: estree.Literal & {
        value: string;
    }

    Settings

    +StringLiteral | SonarJS linter helper functions

    Type Alias StringLiteral

    StringLiteral: estree.Literal & {
        value: string;
    }

    Settings

    diff --git a/typedoc/types/Values.html b/typedoc/types/Values.html index 31c1a644e29..2e26548894a 100644 --- a/typedoc/types/Values.html +++ b/typedoc/types/Values.html @@ -1 +1 @@ -Values | SonarJS linter helper functions

    Type Alias Values

    Values: AssignedValues | UnknownValue

    Settings

    +Values | SonarJS linter helper functions

    Type Alias Values

    Values: AssignedValues | UnknownValue

    Settings

    diff --git a/typedoc/variables/FUNCTION_NODES.html b/typedoc/variables/FUNCTION_NODES.html index 12dcd235daf..2aac5bfe507 100644 --- a/typedoc/variables/FUNCTION_NODES.html +++ b/typedoc/variables/FUNCTION_NODES.html @@ -1 +1 @@ -FUNCTION_NODES | SonarJS linter helper functions

    Variable FUNCTION_NODESConst

    FUNCTION_NODES: string[] = ...

    Settings

    +FUNCTION_NODES | SonarJS linter helper functions

    Variable FUNCTION_NODESConst

    FUNCTION_NODES: string[] = ...

    Settings

    diff --git a/typedoc/variables/PACKAGE_JSON.html b/typedoc/variables/PACKAGE_JSON.html index ea4dfbd233f..03136414ca9 100644 --- a/typedoc/variables/PACKAGE_JSON.html +++ b/typedoc/variables/PACKAGE_JSON.html @@ -1 +1 @@ -PACKAGE_JSON | SonarJS linter helper functions

    Variable PACKAGE_JSONConst

    PACKAGE_JSON: "package.json" = 'package.json'

    Settings

    +PACKAGE_JSON | SonarJS linter helper functions

    Variable PACKAGE_JSONConst

    PACKAGE_JSON: "package.json" = 'package.json'

    Settings

    diff --git a/typedoc/variables/SONAR_RUNTIME.html b/typedoc/variables/SONAR_RUNTIME.html index 8c5d3cdfb7e..cc2ba16cb03 100644 --- a/typedoc/variables/SONAR_RUNTIME.html +++ b/typedoc/variables/SONAR_RUNTIME.html @@ -1 +1 @@ -SONAR_RUNTIME | SonarJS linter helper functions

    Variable SONAR_RUNTIMEConst

    SONAR_RUNTIME: "sonar-runtime" = 'sonar-runtime'

    Settings

    +SONAR_RUNTIME | SonarJS linter helper functions

    Variable SONAR_RUNTIMEConst

    SONAR_RUNTIME: "sonar-runtime" = 'sonar-runtime'

    Settings

    diff --git a/typedoc/variables/TYPED_ARRAY_TYPES.html b/typedoc/variables/TYPED_ARRAY_TYPES.html index a91f49ec7b4..4d3ea9397d4 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

    Variable TYPED_ARRAY_TYPESConst

    TYPED_ARRAY_TYPES: string[] = ...

    JavaScript typed arrays https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Typed_arrays

    -

    Settings

    +

    Settings

    diff --git a/typedoc/variables/UTILITY_TYPES.html b/typedoc/variables/UTILITY_TYPES.html index ccf8f103123..1da9523d019 100644 --- a/typedoc/variables/UTILITY_TYPES.html +++ b/typedoc/variables/UTILITY_TYPES.html @@ -1,3 +1,3 @@ UTILITY_TYPES | SonarJS linter helper functions

    Variable UTILITY_TYPESConst

    UTILITY_TYPES: Set<string> = ...

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

    See

    https://www.typescriptlang.org/docs/handbook/utility-types.html

    -

    Settings

    +

    Settings

    diff --git a/typedoc/variables/collectionConstructor.html b/typedoc/variables/collectionConstructor.html index 9c480906f66..f1775dc9fcf 100644 --- a/typedoc/variables/collectionConstructor.html +++ b/typedoc/variables/collectionConstructor.html @@ -1 +1 @@ -collectionConstructor | SonarJS linter helper functions

    Variable collectionConstructorConst

    collectionConstructor: string[] = ...

    Settings

    +collectionConstructor | SonarJS linter helper functions

    Variable collectionConstructorConst

    collectionConstructor: string[] = ...

    Settings

    diff --git a/typedoc/variables/copyingSortLike.html b/typedoc/variables/copyingSortLike.html index 54892228d24..43aafe47e63 100644 --- a/typedoc/variables/copyingSortLike.html +++ b/typedoc/variables/copyingSortLike.html @@ -1 +1 @@ -copyingSortLike | SonarJS linter helper functions

    Variable copyingSortLikeConst

    copyingSortLike: string[] = ...

    Settings

    +copyingSortLike | SonarJS linter helper functions

    Variable copyingSortLikeConst

    copyingSortLike: string[] = ...

    Settings

    diff --git a/typedoc/variables/detectReactRule.html b/typedoc/variables/detectReactRule.html index b82a20c4708..45af0cd0be3 100644 --- a/typedoc/variables/detectReactRule.html +++ b/typedoc/variables/detectReactRule.html @@ -1 +1 @@ -detectReactRule | SonarJS linter helper functions

    Variable detectReactRuleConst

    detectReactRule: Rule.RuleModule = ...

    Settings

    +detectReactRule | SonarJS linter helper functions

    Variable detectReactRuleConst

    detectReactRule: Rule.RuleModule = ...

    Settings

    diff --git a/typedoc/variables/functionLike.html b/typedoc/variables/functionLike.html index 82b4bbdab6b..d3875cc6ace 100644 --- a/typedoc/variables/functionLike.html +++ b/typedoc/variables/functionLike.html @@ -1 +1 @@ -functionLike | SonarJS linter helper functions

    Variable functionLikeConst

    functionLike: Set<string> = ...

    Settings

    +functionLike | SonarJS linter helper functions

    Variable functionLikeConst

    functionLike: Set<string> = ...

    Settings

    diff --git a/typedoc/variables/globalsByLibraries.html b/typedoc/variables/globalsByLibraries.html index 78bc1976ebc..80f6cb8532e 100644 --- a/typedoc/variables/globalsByLibraries.html +++ b/typedoc/variables/globalsByLibraries.html @@ -1 +1 @@ -globalsByLibraries | SonarJS linter helper functions

    Variable globalsByLibrariesConst

    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[];
    } = ...

    Settings

    +globalsByLibraries | SonarJS linter helper functions

    Variable globalsByLibrariesConst

    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[];
    } = ...

    Settings

    diff --git a/typedoc/variables/sortLike.html b/typedoc/variables/sortLike.html index 28c360fb9bd..f4d52093a21 100644 --- a/typedoc/variables/sortLike.html +++ b/typedoc/variables/sortLike.html @@ -1 +1 @@ -sortLike | SonarJS linter helper functions

    Variable sortLikeConst

    sortLike: string[] = ...

    Settings

    +sortLike | SonarJS linter helper functions

    Variable sortLikeConst

    sortLike: string[] = ...

    Settings

    diff --git a/typedoc/variables/unknownValue.html b/typedoc/variables/unknownValue.html index d0049d42c41..a8b73e26e8d 100644 --- a/typedoc/variables/unknownValue.html +++ b/typedoc/variables/unknownValue.html @@ -1 +1 @@ -unknownValue | SonarJS linter helper functions

    Variable unknownValueConst

    unknownValue: UnknownValue = ...

    Settings

    +unknownValue | SonarJS linter helper functions

    Variable unknownValueConst

    unknownValue: UnknownValue = ...

    Settings

    diff --git a/typedoc/variables/writingMethods.html b/typedoc/variables/writingMethods.html index f1dce39f7ce..875955e4d6d 100644 --- a/typedoc/variables/writingMethods.html +++ b/typedoc/variables/writingMethods.html @@ -1 +1 @@ -writingMethods | SonarJS linter helper functions

    Variable writingMethodsConst

    writingMethods: string[] = ...

    Settings

    +writingMethods | SonarJS linter helper functions

    Variable writingMethodsConst

    writingMethods: string[] = ...

    Settings