diff --git a/typedoc/classes/LiveVariables.html b/typedoc/classes/LiveVariables.html index 10bac6e650..0ea9969f54 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

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

Settings

On This Page

Constructors
Properties
Methods
diff --git a/typedoc/classes/ReachingDefinitions.html b/typedoc/classes/ReachingDefinitions.html index 0c73a7aaff..5e0a71a6f6 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 ffba0abdf6..b07557c34e 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 89a854fac7..1475538ef7 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 df32ecbfbe..a63b421ac9 100644 --- a/typedoc/functions/AwsIamPolicyTemplate.html +++ b/typedoc/functions/AwsIamPolicyTemplate.html @@ -1 +1 @@ -AwsIamPolicyTemplate | SonarJS linter helper functions

    Function AwsIamPolicyTemplate

    • AwsIamPolicyTemplate(
          statementChecker: StatementChecker,
          meta: RuleMetaData,
      ): RuleModule

    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    Settings

    +AwsIamPolicyTemplate | SonarJS linter helper functions

    Function AwsIamPolicyTemplate

    • AwsIamPolicyTemplate(
          statementChecker: StatementChecker,
          meta: RuleMetaData,
      ): RuleModule

    • Parameters

      • statementChecker: StatementChecker
      • meta: RuleMetaData

      Returns RuleModule

    Settings

    diff --git a/typedoc/functions/Chai.isAssertion.html b/typedoc/functions/Chai.isAssertion.html index 2d38e55b66..8dec97b85c 100644 --- a/typedoc/functions/Chai.isAssertion.html +++ b/typedoc/functions/Chai.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: Node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: 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 88e02c6494..f28f6ac090 100644 --- a/typedoc/functions/Chai.isImported.html +++ b/typedoc/functions/Chai.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html b/typedoc/functions/Express.SensitiveMiddlewarePropertyRule.html index c1cac78d2f..407e40fcdf 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 fec626112d..4b8938d16f 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: Function,
          context: RuleContext,
          node: 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 df383c95ba..4806277b1f 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: VariableDeclarator,
          context: RuleContext,
      ): 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 5fc2447d27..db07f7823c 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: RuleContext,
          middlewares: string[],
          n: Node,
      ): 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 5566483a59..3a5a7dd73e 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: RuleContext,
          callExpression: CallExpression,
          app: Identifier,
          middlewareNodePredicate: (n: Node) => boolean,
      ): 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

      Returns boolean

    Settings

    +

    Parameters

    Returns boolean

    Settings

    diff --git a/typedoc/functions/Mocha.extractTestCase.html b/typedoc/functions/Mocha.extractTestCase.html index 1a026874bd..914207500b 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 e85afbd2fe..0e8f04adc9 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: 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 d0926c99ac..ae041c7040 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: 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 e7345075ea..5165bd942e 100644 --- a/typedoc/functions/Mocha.isTestConstruct.html +++ b/typedoc/functions/Mocha.isTestConstruct.html @@ -1 +1 @@ -isTestConstruct | SonarJS linter helper functions

    Function isTestConstruct

    • isTestConstruct(node: Node, constructs?: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isTestConstruct | SonarJS linter helper functions

    Function isTestConstruct

    • isTestConstruct(node: Node, constructs?: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/S3BucketTemplate.html b/typedoc/functions/S3BucketTemplate.html index 81b1d75c7a..52f0831012 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 faac3a1b29..a5cd875660 100644 --- a/typedoc/functions/Sinon.isAssertion.html +++ b/typedoc/functions/Sinon.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: Node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: 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 e5071aa729..8f19fe2fff 100644 --- a/typedoc/functions/Sinon.isImported.html +++ b/typedoc/functions/Sinon.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/Vitest.isAssertion.html b/typedoc/functions/Vitest.isAssertion.html index c5bde86de4..3b1192d2c4 100644 --- a/typedoc/functions/Vitest.isAssertion.html +++ b/typedoc/functions/Vitest.isAssertion.html @@ -1 +1 @@ -isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: Node): boolean

    • Parameters

      • context: RuleContext
      • node: Node

      Returns boolean

    Settings

    +isAssertion | SonarJS linter helper functions

    Function isAssertion

    • isAssertion(context: RuleContext, node: 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 8558322ccc..8ab9e1eb3e 100644 --- a/typedoc/functions/Vitest.isImported.html +++ b/typedoc/functions/Vitest.isImported.html @@ -1 +1 @@ -isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    +isImported | SonarJS linter helper functions

    Function isImported

    • isImported(context: RuleContext): boolean

    • Parameters

      • context: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/ancestorsChain.html b/typedoc/functions/ancestorsChain.html index 15e0308a64..006dd53d3d 100644 --- a/typedoc/functions/ancestorsChain.html +++ b/typedoc/functions/ancestorsChain.html @@ -1 +1 @@ -ancestorsChain | SonarJS linter helper functions

    Function ancestorsChain

    • ancestorsChain(node: Node, boundaryTypes: Set<string>): Node[]

    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    Settings

    +ancestorsChain | SonarJS linter helper functions

    Function ancestorsChain

    • ancestorsChain(node: Node, boundaryTypes: Set<string>): Node[]

    • Parameters

      • node: Node
      • boundaryTypes: Set<string>

      Returns Node[]

    Settings

    diff --git a/typedoc/functions/areEquivalent.html b/typedoc/functions/areEquivalent.html index 2e6d3b136b..7cf5d051f6 100644 --- a/typedoc/functions/areEquivalent.html +++ b/typedoc/functions/areEquivalent.html @@ -1,4 +1,4 @@ areEquivalent | SonarJS linter helper functions

    Function areEquivalent

    • areEquivalent(
          first: Node | Node[],
          second: Node | Node[],
          sourceCode: 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 093df09f94..5e2d138f5d 100644 --- a/typedoc/functions/checkSensitiveCall.html +++ b/typedoc/functions/checkSensitiveCall.html @@ -1 +1 @@ -checkSensitiveCall | SonarJS linter helper functions

    Function checkSensitiveCall

    • checkSensitiveCall(
          context: RuleContext,
          callExpression: CallExpression,
          sensitiveArgumentIndex: number,
          sensitiveProperty: string,
          sensitivePropertyValue: boolean,
          message: string,
      ): 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: RuleContext,
          callExpression: CallExpression,
          sensitiveArgumentIndex: number,
          sensitiveProperty: string,
          sensitivePropertyValue: boolean,
          message: string,
      ): 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 38fa5f89b5..ad3942e3b9 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/clearDependenciesCache.html b/typedoc/functions/clearDependenciesCache.html index 41e69d09b1..2b3dd35808 100644 --- a/typedoc/functions/clearDependenciesCache.html +++ b/typedoc/functions/clearDependenciesCache.html @@ -1,2 +1,2 @@ clearDependenciesCache | SonarJS linter helper functions

    Function clearDependenciesCache

    • clearDependenciesCache(): void

    • In the case of SonarIDE, when a package.json file changes, the cache can become obsolete.

      -

      Returns void

    Settings

    +

    Returns void

    Settings

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

    Function collectIfBranches

    • collectIfBranches(
          node: IfStatement,
      ): { 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 }

    Settings

    +

    Parameters

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

    Settings

    diff --git a/typedoc/functions/collectSwitchBranches.html b/typedoc/functions/collectSwitchBranches.html index 0a38110bf2..347ac32ba2 100644 --- a/typedoc/functions/collectSwitchBranches.html +++ b/typedoc/functions/collectSwitchBranches.html @@ -1,2 +1,2 @@ collectSwitchBranches | SonarJS linter helper functions

    Function collectSwitchBranches

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

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

      -

      Parameters

      • node: SwitchStatement

      Returns { 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 79769d5a30..5d87171fbd 100644 --- a/typedoc/functions/encodeContents.html +++ b/typedoc/functions/encodeContents.html @@ -1 +1 @@ -encodeContents | SonarJS linter helper functions

    Function encodeContents

    • encodeContents(
          message: string,
          secondaryLocations?: IssueLocation[],
          cost?: number,
      ): string

    • Parameters

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

      Returns string

    Settings

    +encodeContents | SonarJS linter helper functions

    Function encodeContents

    • encodeContents(
          message: string,
          secondaryLocations?: IssueLocation[],
          cost?: number,
      ): string

    • Parameters

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

      Returns string

    Settings

    diff --git a/typedoc/functions/expandMessage.html b/typedoc/functions/expandMessage.html index 601588416f..38856eeef8 100644 --- a/typedoc/functions/expandMessage.html +++ b/typedoc/functions/expandMessage.html @@ -1 +1 @@ -expandMessage | SonarJS linter helper functions

    Function expandMessage

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

    • Parameters

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

      Returns string

    Settings

    +expandMessage | SonarJS linter helper functions

    Function expandMessage

    • expandMessage(
          message: string,
          reportDescriptorData: undefined | Record<string, unknown>,
      ): 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 ff96ce627b..e0d5720e26 100644 --- a/typedoc/functions/findFirstMatchingAncestor.html +++ b/typedoc/functions/findFirstMatchingAncestor.html @@ -1 +1 @@ -findFirstMatchingAncestor | SonarJS linter helper functions

    Function findFirstMatchingAncestor

    • findFirstMatchingAncestor(
          node: Node,
          predicate: (node: Node) => boolean,
      ): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    +findFirstMatchingAncestor | SonarJS linter helper functions

    Function findFirstMatchingAncestor

    • findFirstMatchingAncestor(
          node: Node,
          predicate: (node: Node) => boolean,
      ): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    diff --git a/typedoc/functions/findFirstMatchingLocalAncestor.html b/typedoc/functions/findFirstMatchingLocalAncestor.html index a2d395afab..0ed7813129 100644 --- a/typedoc/functions/findFirstMatchingLocalAncestor.html +++ b/typedoc/functions/findFirstMatchingLocalAncestor.html @@ -1 +1 @@ -findFirstMatchingLocalAncestor | SonarJS linter helper functions

    Function findFirstMatchingLocalAncestor

    • findFirstMatchingLocalAncestor(
          node: Node,
          predicate: (node: Node) => boolean,
      ): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    +findFirstMatchingLocalAncestor | SonarJS linter helper functions

    Function findFirstMatchingLocalAncestor

    • findFirstMatchingLocalAncestor(
          node: Node,
          predicate: (node: Node) => boolean,
      ): undefined | Node

    • Parameters

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

      Returns undefined | Node

    Settings

    diff --git a/typedoc/functions/findParent.html b/typedoc/functions/findParent.html index 80a3459130..0d62bbdaab 100644 --- a/typedoc/functions/findParent.html +++ b/typedoc/functions/findParent.html @@ -1,3 +1,3 @@ findParent | SonarJS linter helper functions

    Function findParent

    • findParent(dir: string, name: string): 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 607739f1c1..3de5b2d804 100644 --- a/typedoc/functions/findPropagatedSetting.html +++ b/typedoc/functions/findPropagatedSetting.html @@ -1,2 +1,2 @@ findPropagatedSetting | SonarJS linter helper functions

    Function findPropagatedSetting

    • findPropagatedSetting(
          sensitiveProperty: Property,
          propagatedValue: Node,
      ): 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 0bb4e48952..00762d6d7b 100644 --- a/typedoc/functions/flatMap.html +++ b/typedoc/functions/flatMap.html @@ -1 +1 @@ -flatMap | SonarJS linter helper functions

    Function flatMap

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

    • Type Parameters

      • A
      • B

      Parameters

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

      Returns B[]

    Settings

    +flatMap | SonarJS linter helper functions

    Function flatMap

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

    • Type Parameters

      • A
      • B

      Parameters

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

      Returns B[]

    Settings

    diff --git a/typedoc/functions/flattenArgs.html b/typedoc/functions/flattenArgs.html index c4f187307c..455c04b432 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 12929f72b3..e084013a5e 100644 --- a/typedoc/functions/generateMeta.html +++ b/typedoc/functions/generateMeta.html @@ -1 +1 @@ -generateMeta | SonarJS linter helper functions

    Function generateMeta

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

    • Parameters

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

      Returns Rule.RuleMetaData

    Settings

    +generateMeta | SonarJS linter helper functions

    Function generateMeta

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

    • Parameters

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

      Returns Rule.RuleMetaData

    Settings

    diff --git a/typedoc/functions/getAllDependencies.html b/typedoc/functions/getAllDependencies.html index 5bb3d8194f..ec6fe33a79 100644 --- a/typedoc/functions/getAllDependencies.html +++ b/typedoc/functions/getAllDependencies.html @@ -1,4 +1,4 @@ getAllDependencies | SonarJS linter helper functions

    Function getAllDependencies

    • getAllDependencies(): NamedDependency[]

    • Returns the dependencies of the root package.json file collected in the cache. As the cache is populated lazily, it could be null in case no rule execution has touched it. This removes duplicate dependencies and keeps the last occurrence.

      -

      Returns NamedDependency[]

    Settings

    +

    Returns NamedDependency[]

    Settings

    diff --git a/typedoc/functions/getBucketProperty.html b/typedoc/functions/getBucketProperty.html index af6a1fb018..45b6bcd29b 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 f730a3715c..387fb800d0 100644 --- a/typedoc/functions/getDependencies.html +++ b/typedoc/functions/getDependencies.html @@ -1,4 +1,4 @@ getDependencies | SonarJS linter helper functions

    Function getDependencies

    • getDependencies(filename: string, cwd: string): 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 08b07815f2..4d344e6b1a 100644 --- a/typedoc/functions/getDependenciesFromPackageJson.html +++ b/typedoc/functions/getDependenciesFromPackageJson.html @@ -1 +1 @@ -getDependenciesFromPackageJson | SonarJS linter helper functions

    Function getDependenciesFromPackageJson

    • getDependenciesFromPackageJson(content: PackageJson): Set<Dependency>

    • Parameters

      • content: PackageJson

      Returns Set<Dependency>

    Settings

    +getDependenciesFromPackageJson | SonarJS linter helper functions

    Function getDependenciesFromPackageJson

    • getDependenciesFromPackageJson(content: PackageJson): Set<Dependency>

    • Parameters

      • content: PackageJson

      Returns Set<Dependency>

    Settings

    diff --git a/typedoc/functions/getElementType.html b/typedoc/functions/getElementType.html index 34d87692b0..04d52e10f0 100644 --- a/typedoc/functions/getElementType.html +++ b/typedoc/functions/getElementType.html @@ -1 +1 @@ -getElementType | SonarJS linter helper functions

    Function getElementType

    • getElementType(context: RuleContext): (node: JSXOpeningElement) => string

    • Parameters

      • context: RuleContext

      Returns (node: JSXOpeningElement) => string

    Settings

    +getElementType | SonarJS linter helper functions

    Function getElementType

    • getElementType(context: RuleContext): (node: JSXOpeningElement) => string

    • Parameters

      • context: RuleContext

      Returns (node: JSXOpeningElement) => string

    Settings

    diff --git a/typedoc/functions/getFirstToken.html b/typedoc/functions/getFirstToken.html index 0a044b545e..092b296ea5 100644 --- a/typedoc/functions/getFirstToken.html +++ b/typedoc/functions/getFirstToken.html @@ -1 +1 @@ -getFirstToken | SonarJS linter helper functions

    Function getFirstToken

    • getFirstToken<T = string>(
          node: Node,
          context: RuleContext<string, T[]>,
      ): 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 = string>(
          node: Node,
          context: RuleContext<string, T[]>,
      ): 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 f2eb713c0a..14508d0e25 100644 --- a/typedoc/functions/getFirstTokenAfter.html +++ b/typedoc/functions/getFirstTokenAfter.html @@ -1 +1 @@ -getFirstTokenAfter | SonarJS linter helper functions

    Function getFirstTokenAfter

    • getFirstTokenAfter<T = string>(
          node: Node,
          context: RuleContext<string, T[]>,
      ): 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 = string>(
          node: Node,
          context: RuleContext<string, T[]>,
      ): 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 2b11ecd2e8..3a78bd5d79 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 f27b2b9c72..133363c2e0 100644 --- a/typedoc/functions/getFullyQualifiedNameRaw.html +++ b/typedoc/functions/getFullyQualifiedNameRaw.html @@ -1,3 +1,3 @@ getFullyQualifiedNameRaw | SonarJS linter helper functions

    Function getFullyQualifiedNameRaw

    • getFullyQualifiedNameRaw(
          context: RuleContext,
          node: Node,
          fqn: string[],
          scope?: Scope,
          visitedVars?: Variable[],
      ): 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 31433adcf8..d4ed82c4f7 100644 --- a/typedoc/functions/getImportDeclarations.html +++ b/typedoc/functions/getImportDeclarations.html @@ -1 +1 @@ -getImportDeclarations | SonarJS linter helper functions

    Function getImportDeclarations

    • getImportDeclarations(context: RuleContext): ImportDeclaration[]

    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    Settings

    +getImportDeclarations | SonarJS linter helper functions

    Function getImportDeclarations

    • getImportDeclarations(context: RuleContext): ImportDeclaration[]

    • Parameters

      • context: RuleContext

      Returns ImportDeclaration[]

    Settings

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

    Function getJsxShortCircuitNodes

    • getJsxShortCircuitNodes(
          logicalExpression: LogicalExpression,
      ): null | LogicalExpression[]

    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    Settings

    +getJsxShortCircuitNodes | SonarJS linter helper functions

    Function getJsxShortCircuitNodes

    • getJsxShortCircuitNodes(
          logicalExpression: LogicalExpression,
      ): null | LogicalExpression[]

    • Parameters

      • logicalExpression: LogicalExpression

      Returns null | LogicalExpression[]

    Settings

    diff --git a/typedoc/functions/getLhsVariable.html b/typedoc/functions/getLhsVariable.html index cf696fdf0b..5e17e266e5 100644 --- a/typedoc/functions/getLhsVariable.html +++ b/typedoc/functions/getLhsVariable.html @@ -1,2 +1,2 @@ getLhsVariable | SonarJS linter helper functions

    Function getLhsVariable

    • getLhsVariable(context: RuleContext, node: 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 acf51c265b..9f8ba5432c 100644 --- a/typedoc/functions/getLiteralValue.html +++ b/typedoc/functions/getLiteralValue.html @@ -1 +1 @@ -getLiteralValue | SonarJS linter helper functions

    Function getLiteralValue

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

    • Parameters

      • ctx: RuleContext
      • node: Node

      Returns estree.Literal | undefined

    Settings

    +getLiteralValue | SonarJS linter helper functions

    Function getLiteralValue

    • getLiteralValue(ctx: RuleContext, node: 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 2fc0df1dd6..b6edb7ae98 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 727a6872a0..5b254aa628 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: string,
          workingDirectory?: string,
          fileSystem?: 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 c1254d7d7f..1c0f39a92c 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 3e096afb71..00745ea2d4 100644 --- a/typedoc/functions/getParent.html +++ b/typedoc/functions/getParent.html @@ -1 +1 @@ -getParent | SonarJS linter helper functions

    Function getParent

    • getParent(
          context: RuleContext,
          node: 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: RuleContext,
          node: 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 575d0a04a1..7233d3d036 100644 --- a/typedoc/functions/getProgramStatements.html +++ b/typedoc/functions/getProgramStatements.html @@ -1 +1 @@ -getProgramStatements | SonarJS linter helper functions

    Function getProgramStatements

    • getProgramStatements(program: Program): Statement[]

    • Parameters

      • program: Program

      Returns Statement[]

    Settings

    +getProgramStatements | SonarJS linter helper functions

    Function getProgramStatements

    • getProgramStatements(program: Program): Statement[]

    • Parameters

      • program: Program

      Returns Statement[]

    Settings

    diff --git a/typedoc/functions/getProperty.html b/typedoc/functions/getProperty.html index 2acd387846..672aba506e 100644 --- a/typedoc/functions/getProperty.html +++ b/typedoc/functions/getProperty.html @@ -1,4 +1,4 @@ getProperty | SonarJS linter helper functions

    Function getProperty

    • getProperty(
          expr: undefined | null | Node,
          key: string,
          ctx: RuleContext,
      ): 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 75db81acda..02d814da1a 100644 --- a/typedoc/functions/getPropertyWithValue.html +++ b/typedoc/functions/getPropertyWithValue.html @@ -1 +1 @@ -getPropertyWithValue | SonarJS linter helper functions

    Function getPropertyWithValue

    • getPropertyWithValue(
          context: RuleContext,
          objectExpression: ObjectExpression,
          propertyName: string,
          propertyValue:
              | undefined
              | null
              | string
              | number
              | bigint
              | boolean
              | RegExp,
      ): 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: RuleContext,
          objectExpression: ObjectExpression,
          propertyName: string,
          propertyValue:
              | undefined
              | null
              | string
              | number
              | bigint
              | boolean
              | RegExp,
      ): 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 7657f23271..f3da31c16a 100644 --- a/typedoc/functions/getRequireCalls.html +++ b/typedoc/functions/getRequireCalls.html @@ -1 +1 @@ -getRequireCalls | SonarJS linter helper functions

    Function getRequireCalls

    • getRequireCalls(context: RuleContext): CallExpression[]

    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    Settings

    +getRequireCalls | SonarJS linter helper functions

    Function getRequireCalls

    • getRequireCalls(context: RuleContext): CallExpression[]

    • Parameters

      • context: RuleContext

      Returns CallExpression[]

    Settings

    diff --git a/typedoc/functions/getSensitiveEffect.html b/typedoc/functions/getSensitiveEffect.html index e7aefea056..66718bfa23 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 9d68ff5c1f..b762469cb0 100644 --- a/typedoc/functions/getSignatureFromCallee.html +++ b/typedoc/functions/getSignatureFromCallee.html @@ -1 +1 @@ -getSignatureFromCallee | SonarJS linter helper functions

    Function getSignatureFromCallee

    • getSignatureFromCallee(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): undefined | Signature

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    Settings

    +getSignatureFromCallee | SonarJS linter helper functions

    Function getSignatureFromCallee

    • getSignatureFromCallee(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): undefined | Signature

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Signature

    Settings

    diff --git a/typedoc/functions/getSimpleRawStringValue.html b/typedoc/functions/getSimpleRawStringValue.html index 4a0ab443f4..dc635f0940 100644 --- a/typedoc/functions/getSimpleRawStringValue.html +++ b/typedoc/functions/getSimpleRawStringValue.html @@ -1 +1 @@ -getSimpleRawStringValue | SonarJS linter helper functions

    Function getSimpleRawStringValue

    • getSimpleRawStringValue(node: TaggedTemplateExpression): string

    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    Settings

    +getSimpleRawStringValue | SonarJS linter helper functions

    Function getSimpleRawStringValue

    • getSimpleRawStringValue(node: TaggedTemplateExpression): string

    • Parameters

      • node: TaggedTemplateExpression

      Returns string

    Settings

    diff --git a/typedoc/functions/getSymbolAtLocation.html b/typedoc/functions/getSymbolAtLocation.html index 542a0552f1..9678b6d6f6 100644 --- a/typedoc/functions/getSymbolAtLocation.html +++ b/typedoc/functions/getSymbolAtLocation.html @@ -1 +1 @@ -getSymbolAtLocation | SonarJS linter helper functions

    Function getSymbolAtLocation

    • getSymbolAtLocation(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): undefined | Symbol

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    Settings

    +getSymbolAtLocation | SonarJS linter helper functions

    Function getSymbolAtLocation

    • getSymbolAtLocation(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): undefined | Symbol

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns undefined | Symbol

    Settings

    diff --git a/typedoc/functions/getTypeAsString.html b/typedoc/functions/getTypeAsString.html index c7663fcb65..23e3bb7cfc 100644 --- a/typedoc/functions/getTypeAsString.html +++ b/typedoc/functions/getTypeAsString.html @@ -1 +1 @@ -getTypeAsString | SonarJS linter helper functions

    Function getTypeAsString

    • getTypeAsString(node: Node, services: ParserServicesWithTypeInformation): string

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    Settings

    +getTypeAsString | SonarJS linter helper functions

    Function getTypeAsString

    • getTypeAsString(node: Node, services: ParserServicesWithTypeInformation): string

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns string

    Settings

    diff --git a/typedoc/functions/getTypeFromTreeNode.html b/typedoc/functions/getTypeFromTreeNode.html index 1f78b7d419..522dd37540 100644 --- a/typedoc/functions/getTypeFromTreeNode.html +++ b/typedoc/functions/getTypeFromTreeNode.html @@ -1 +1 @@ -getTypeFromTreeNode | SonarJS linter helper functions

    Function getTypeFromTreeNode

    • getTypeFromTreeNode(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): Type

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    Settings

    +getTypeFromTreeNode | SonarJS linter helper functions

    Function getTypeFromTreeNode

    • getTypeFromTreeNode(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): Type

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns Type

    Settings

    diff --git a/typedoc/functions/getUnionTypes.html b/typedoc/functions/getUnionTypes.html index 1a1935d368..8abb00bd50 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 7e817fd50d..4345e32185 100644 --- a/typedoc/functions/getUniqueWriteReference.html +++ b/typedoc/functions/getUniqueWriteReference.html @@ -1 +1 @@ -getUniqueWriteReference | SonarJS linter helper functions

    Function getUniqueWriteReference

    • getUniqueWriteReference(variable: undefined | Variable): estree.Node | undefined

    • Parameters

      • variable: undefined | Variable

      Returns estree.Node | undefined

    Settings

    +getUniqueWriteReference | SonarJS linter helper functions

    Function getUniqueWriteReference

    • getUniqueWriteReference(variable: undefined | 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 b47082a751..c439e2521e 100644 --- a/typedoc/functions/getUniqueWriteUsage.html +++ b/typedoc/functions/getUniqueWriteUsage.html @@ -1 +1 @@ -getUniqueWriteUsage | SonarJS linter helper functions

    Function getUniqueWriteUsage

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

    • Parameters

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

      Returns undefined | Node

    Settings

    +getUniqueWriteUsage | SonarJS linter helper functions

    Function getUniqueWriteUsage

    • getUniqueWriteUsage(
          context: RuleContext,
          name: string,
          node: 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 7642f73c57..743374ca23 100644 --- a/typedoc/functions/getUniqueWriteUsageOrNode.html +++ b/typedoc/functions/getUniqueWriteUsageOrNode.html @@ -1 +1 @@ -getUniqueWriteUsageOrNode | SonarJS linter helper functions

    Function getUniqueWriteUsageOrNode

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

    • Parameters

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

      Returns estree.Node

    Settings

    +getUniqueWriteUsageOrNode | SonarJS linter helper functions

    Function getUniqueWriteUsageOrNode

    • getUniqueWriteUsageOrNode(
          context: RuleContext,
          node: Node,
          recursive?: boolean,
      ): 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 d94c5df4f3..58217c502e 100644 --- a/typedoc/functions/getValueOfExpression.html +++ b/typedoc/functions/getValueOfExpression.html @@ -1 +1 @@ -getValueOfExpression | SonarJS linter helper functions

    Function getValueOfExpression

    • getValueOfExpression<
          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",
      >(
          context: RuleContext,
          expr: undefined | null | Node,
          type: T,
          recursive?: boolean,
      ): 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 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",
      >(
          context: RuleContext,
          expr: undefined | null | Node,
          type: T,
          recursive?: boolean,
      ): 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 82321cbccc..80b988be2d 100644 --- a/typedoc/functions/getVariableFromIdentifier.html +++ b/typedoc/functions/getVariableFromIdentifier.html @@ -1 +1 @@ -getVariableFromIdentifier | SonarJS linter helper functions

    Function getVariableFromIdentifier

    • getVariableFromIdentifier(
          identifier: Identifier,
          scope: Scope,
      ): undefined | Variable

    • Parameters

      • identifier: Identifier
      • scope: Scope

      Returns undefined | Variable

    Settings

    +getVariableFromIdentifier | SonarJS linter helper functions

    Function getVariableFromIdentifier

    • getVariableFromIdentifier(
          identifier: Identifier,
          scope: 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 8935feb1ad..8724d40b24 100644 --- a/typedoc/functions/getVariableFromName.html +++ b/typedoc/functions/getVariableFromName.html @@ -1 +1 @@ -getVariableFromName | SonarJS linter helper functions

    Function getVariableFromName

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

    • Parameters

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

      Returns undefined | Variable

    Settings

    +getVariableFromName | SonarJS linter helper functions

    Function getVariableFromName

    • getVariableFromName(
          context: RuleContext,
          name: string,
          node: 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 a0bce5684d..09c409af34 100644 --- a/typedoc/functions/getVariableFromScope.html +++ b/typedoc/functions/getVariableFromScope.html @@ -1 +1 @@ -getVariableFromScope | SonarJS linter helper functions

    Function getVariableFromScope

    • getVariableFromScope(scope: null | Scope, name: string): undefined | Variable

    • Parameters

      • scope: null | Scope
      • name: string

      Returns undefined | Variable

    Settings

    +getVariableFromScope | SonarJS linter helper functions

    Function getVariableFromScope

    • getVariableFromScope(scope: null | Scope, name: string): 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 9f970a8605..6ebb69f183 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 1951747347..1fac84008d 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 5b2f8b519a..a2ec388117 100644 --- a/typedoc/functions/isAny.html +++ b/typedoc/functions/isAny.html @@ -1 +1 @@ -isAny | SonarJS linter helper functions

    Function isAny

    • isAny(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isAny | SonarJS linter helper functions

    Function isAny

    • isAny(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isAnyLiteral.html b/typedoc/functions/isAnyLiteral.html index e5c2181c94..f31ba212df 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 fb6b4ae5df..653ba0aaea 100644 --- a/typedoc/functions/isArray.html +++ b/typedoc/functions/isArray.html @@ -1 +1 @@ -isArray | SonarJS linter helper functions

    Function isArray

    • isArray(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isArray | SonarJS linter helper functions

    Function isArray

    • isArray(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

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

    Function isArrayExpression

    • isArrayExpression(node: undefined | Node): node is ArrayExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrayExpression

    Settings

    +isArrayExpression | SonarJS linter helper functions

    Function isArrayExpression

    • isArrayExpression(node: undefined | 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 0495a61288..e97f316750 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 6c1f25c577..26f9314cd9 100644 --- a/typedoc/functions/isArrowFunctionExpression.html +++ b/typedoc/functions/isArrowFunctionExpression.html @@ -1 +1 @@ -isArrowFunctionExpression | SonarJS linter helper functions

    Function isArrowFunctionExpression

    • isArrowFunctionExpression(
          node: undefined | Node,
      ): node is ArrowFunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is ArrowFunctionExpression

    Settings

    +isArrowFunctionExpression | SonarJS linter helper functions

    Function isArrowFunctionExpression

    • isArrowFunctionExpression(
          node: undefined | 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 7d9faafd35..8b4fde18ed 100644 --- a/typedoc/functions/isBigIntArray.html +++ b/typedoc/functions/isBigIntArray.html @@ -1,4 +1,4 @@ isBigIntArray | SonarJS linter helper functions

    Function isBigIntArray

    • isBigIntArray(type: Type, services: ParserServicesWithTypeInformation): 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 c7a559e53e..f48de76da3 100644 --- a/typedoc/functions/isBigIntType.html +++ b/typedoc/functions/isBigIntType.html @@ -1 +1 @@ -isBigIntType | SonarJS linter helper functions

    Function isBigIntType

    • isBigIntType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isBigIntType | SonarJS linter helper functions

    Function isBigIntType

    • isBigIntType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

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

    Function isBinaryPlus

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

    • Parameters

      • node: Node

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

    Settings

    +isBinaryPlus | SonarJS linter helper functions

    Function isBinaryPlus

    • isBinaryPlus(node: 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 aae28739bb..bd22b5a381 100644 --- a/typedoc/functions/isBooleanLiteral.html +++ b/typedoc/functions/isBooleanLiteral.html @@ -1 +1 @@ -isBooleanLiteral | SonarJS linter helper functions

    Function isBooleanLiteral

    • isBooleanLiteral(node: 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): 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 96237dfd5c..3f20ccbdf8 100644 --- a/typedoc/functions/isBooleanLiteralType.html +++ b/typedoc/functions/isBooleanLiteralType.html @@ -1 +1 @@ -isBooleanLiteralType | SonarJS linter helper functions

    Function isBooleanLiteralType

    • isBooleanLiteralType(
          type: 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,
      ): 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 2282c8e231..a7fd6ff3fd 100644 --- a/typedoc/functions/isBooleanTrueType.html +++ b/typedoc/functions/isBooleanTrueType.html @@ -1 +1 @@ -isBooleanTrueType | SonarJS linter helper functions

    Function isBooleanTrueType

    • isBooleanTrueType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isBooleanTrueType | SonarJS linter helper functions

    Function isBooleanTrueType

    • isBooleanTrueType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isBooleanType.html b/typedoc/functions/isBooleanType.html index cca78a4af2..fc2c5e5ed7 100644 --- a/typedoc/functions/isBooleanType.html +++ b/typedoc/functions/isBooleanType.html @@ -1 +1 @@ -isBooleanType | SonarJS linter helper functions

    Function isBooleanType

    • isBooleanType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isBooleanType | SonarJS linter helper functions

    Function isBooleanType

    • isBooleanType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isCallingMethod.html b/typedoc/functions/isCallingMethod.html index 99bd2e0c2c..117b14941a 100644 --- a/typedoc/functions/isCallingMethod.html +++ b/typedoc/functions/isCallingMethod.html @@ -1 +1 @@ -isCallingMethod | SonarJS linter helper functions

    Function isCallingMethod

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

    • Parameters

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

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

    Settings

    +isCallingMethod | SonarJS linter helper functions

    Function isCallingMethod

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

    • Parameters

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

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

    Settings

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

    Function isDefaultSpecifier

    • isDefaultSpecifier(importDeclaration: ImportDeclaration, name: string): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    +isDefaultSpecifier | SonarJS linter helper functions

    Function isDefaultSpecifier

    • isDefaultSpecifier(importDeclaration: ImportDeclaration, name: string): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isDotNotation.html b/typedoc/functions/isDotNotation.html index 2827f7591c..e4e67f3a7d 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): 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 44f4d6d18a..5cb6b7b4d2 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 02703a929a..02fe121445 100644 --- a/typedoc/functions/isFalseLiteral.html +++ b/typedoc/functions/isFalseLiteral.html @@ -1 +1 @@ -isFalseLiteral | SonarJS linter helper functions

    Function isFalseLiteral

    • isFalseLiteral(n: Node): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    +isFalseLiteral | SonarJS linter helper functions

    Function isFalseLiteral

    • isFalseLiteral(n: Node): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isFunction.html b/typedoc/functions/isFunction.html index 1eedb5fa35..2c1e40334e 100644 --- a/typedoc/functions/isFunction.html +++ b/typedoc/functions/isFunction.html @@ -1 +1 @@ -isFunction | SonarJS linter helper functions

    Function isFunction

    • isFunction(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isFunction | SonarJS linter helper functions

    Function isFunction

    • isFunction(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

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

    Function isFunctionCall

    • isFunctionCall(node: 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): 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 b71060d348..d5693a1579 100644 --- a/typedoc/functions/isFunctionDeclaration.html +++ b/typedoc/functions/isFunctionDeclaration.html @@ -1 +1 @@ -isFunctionDeclaration | SonarJS linter helper functions

    Function isFunctionDeclaration

    • isFunctionDeclaration(node: undefined | Node): node is FunctionDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is FunctionDeclaration

    Settings

    +isFunctionDeclaration | SonarJS linter helper functions

    Function isFunctionDeclaration

    • isFunctionDeclaration(node: undefined | 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 071c740271..1688e51e7c 100644 --- a/typedoc/functions/isFunctionExpression.html +++ b/typedoc/functions/isFunctionExpression.html @@ -1 +1 @@ -isFunctionExpression | SonarJS linter helper functions

    Function isFunctionExpression

    • isFunctionExpression(node: undefined | Node): node is FunctionExpression

    • Parameters

      • node: undefined | Node

      Returns node is FunctionExpression

    Settings

    +isFunctionExpression | SonarJS linter helper functions

    Function isFunctionExpression

    • isFunctionExpression(node: undefined | 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 f0265dc863..11756d18de 100644 --- a/typedoc/functions/isFunctionInvocation.html +++ b/typedoc/functions/isFunctionInvocation.html @@ -1 +1 @@ -isFunctionInvocation | SonarJS linter helper functions

    Function isFunctionInvocation

    • isFunctionInvocation(
          callExpression: CallExpression,
          functionName: string,
          minArgs: number,
      ): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isFunctionInvocation | SonarJS linter helper functions

    Function isFunctionInvocation

    • isFunctionInvocation(
          callExpression: CallExpression,
          functionName: string,
          minArgs: number,
      ): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isFunctionNode.html b/typedoc/functions/isFunctionNode.html index a899b19d00..dd0db0a5c3 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 c62e1af7c1..b30678af38 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 921e9b78b9..b04fc9951f 100644 --- a/typedoc/functions/isIdentifier.html +++ b/typedoc/functions/isIdentifier.html @@ -1 +1 @@ -isIdentifier | SonarJS linter helper functions

    Function isIdentifier

    • isIdentifier(node: undefined | Node, ...values: string[]): node is Identifier

    • Parameters

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

      Returns node is Identifier

    Settings

    +isIdentifier | SonarJS linter helper functions

    Function isIdentifier

    • isIdentifier(node: undefined | Node, ...values: string[]): node is Identifier

    • Parameters

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

      Returns node is Identifier

    Settings

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

    Function isIfStatement

    • isIfStatement(node: undefined | Node): node is IfStatement

    • Parameters

      • node: undefined | Node

      Returns node is IfStatement

    Settings

    +isIfStatement | SonarJS linter helper functions

    Function isIfStatement

    • isIfStatement(node: undefined | 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 08fc9e0c25..7a9b3f92c4 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,
      ): 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 8033a34b8b..05a596d7ee 100644 --- a/typedoc/functions/isInsideVueSetupScript.html +++ b/typedoc/functions/isInsideVueSetupScript.html @@ -1 +1 @@ -isInsideVueSetupScript | SonarJS linter helper functions

    Function isInsideVueSetupScript

    • isInsideVueSetupScript(node: Node, ctx: RuleContext): boolean

    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    Settings

    +isInsideVueSetupScript | SonarJS linter helper functions

    Function isInsideVueSetupScript

    • isInsideVueSetupScript(node: Node, ctx: RuleContext): boolean

    • Parameters

      • node: Node
      • ctx: RuleContext

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isLiteral.html b/typedoc/functions/isLiteral.html index e181dc7688..4e5690c47b 100644 --- a/typedoc/functions/isLiteral.html +++ b/typedoc/functions/isLiteral.html @@ -1 +1 @@ -isLiteral | SonarJS linter helper functions

    Function isLiteral

    • isLiteral(n: null | Node): n is Literal

    • Parameters

      • n: null | Node

      Returns n is Literal

    Settings

    +isLiteral | SonarJS linter helper functions

    Function isLiteral

    • isLiteral(n: null | Node): 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 a2486c7d9d..378bf0394f 100644 --- a/typedoc/functions/isLogicalExpression.html +++ b/typedoc/functions/isLogicalExpression.html @@ -1 +1 @@ -isLogicalExpression | SonarJS linter helper functions

    Function isLogicalExpression

    • isLogicalExpression(node: undefined | Node): node is LogicalExpression

    • Parameters

      • node: undefined | Node

      Returns node is LogicalExpression

    Settings

    +isLogicalExpression | SonarJS linter helper functions

    Function isLogicalExpression

    • isLogicalExpression(node: undefined | 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 6b4ef7ee9c..353dad517a 100644 --- a/typedoc/functions/isMemberExpression.html +++ b/typedoc/functions/isMemberExpression.html @@ -1 +1 @@ -isMemberExpression | SonarJS linter helper functions

    Function isMemberExpression

    • isMemberExpression(
          node: Node,
          objectValue: string,
          ...propertyValue: string[],
      ): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMemberExpression | SonarJS linter helper functions

    Function isMemberExpression

    • isMemberExpression(
          node: Node,
          objectValue: string,
          ...propertyValue: string[],
      ): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isMemberWithProperty.html b/typedoc/functions/isMemberWithProperty.html index 75d298aabf..c50f247cd2 100644 --- a/typedoc/functions/isMemberWithProperty.html +++ b/typedoc/functions/isMemberWithProperty.html @@ -1 +1 @@ -isMemberWithProperty | SonarJS linter helper functions

    Function isMemberWithProperty

    • isMemberWithProperty(node: Node, ...values: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMemberWithProperty | SonarJS linter helper functions

    Function isMemberWithProperty

    • isMemberWithProperty(node: Node, ...values: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isMethodCall.html b/typedoc/functions/isMethodCall.html index c37a944076..d4c14d9e91 100644 --- a/typedoc/functions/isMethodCall.html +++ b/typedoc/functions/isMethodCall.html @@ -1 +1 @@ -isMethodCall | SonarJS linter helper functions

    Function isMethodCall

    • isMethodCall(
          callExpr: CallExpression,
      ): 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: CallExpression,
      ): 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 b429b98160..529a175acc 100644 --- a/typedoc/functions/isMethodInvocation.html +++ b/typedoc/functions/isMethodInvocation.html @@ -1 +1 @@ -isMethodInvocation | SonarJS linter helper functions

    Function isMethodInvocation

    • isMethodInvocation(
          callExpression: CallExpression,
          objectIdentifierName: string,
          methodName: string,
          minArgs: number,
      ): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isMethodInvocation | SonarJS linter helper functions

    Function isMethodInvocation

    • isMethodInvocation(
          callExpression: CallExpression,
          objectIdentifierName: string,
          methodName: string,
          minArgs: number,
      ): 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 b2b26566a4..1e5e0ab1a2 100644 --- a/typedoc/functions/isModuleDeclaration.html +++ b/typedoc/functions/isModuleDeclaration.html @@ -1 +1 @@ -isModuleDeclaration | SonarJS linter helper functions

    Function isModuleDeclaration

    • isModuleDeclaration(
          node: undefined | 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: undefined | 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 bed398ab21..3ab6e45bc5 100644 --- a/typedoc/functions/isModuleExports.html +++ b/typedoc/functions/isModuleExports.html @@ -1 +1 @@ -isModuleExports | SonarJS linter helper functions

    Function isModuleExports

    • isModuleExports(node: Node): boolean

    • Parameters

      • node: Node

      Returns boolean

    Settings

    +isModuleExports | SonarJS linter helper functions

    Function isModuleExports

    • isModuleExports(node: Node): boolean

    • Parameters

      • node: Node

      Returns boolean

    Settings

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

    Function isNamespaceSpecifier

    • isNamespaceSpecifier(
          importDeclaration: ImportDeclaration,
          name: string,
      ): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

    +isNamespaceSpecifier | SonarJS linter helper functions

    Function isNamespaceSpecifier

    • isNamespaceSpecifier(
          importDeclaration: ImportDeclaration,
          name: string,
      ): boolean

    • Parameters

      • importDeclaration: ImportDeclaration
      • name: string

      Returns boolean

    Settings

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

    Function isNullLiteral

    • isNullLiteral(n: Node): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    +isNullLiteral | SonarJS linter helper functions

    Function isNullLiteral

    • isNullLiteral(n: Node): boolean

    • Parameters

      • n: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNullOrUndefinedType.html b/typedoc/functions/isNullOrUndefinedType.html index 63051a8d10..ad0fe6596e 100644 --- a/typedoc/functions/isNullOrUndefinedType.html +++ b/typedoc/functions/isNullOrUndefinedType.html @@ -1 +1 @@ -isNullOrUndefinedType | SonarJS linter helper functions

    Function isNullOrUndefinedType

    • isNullOrUndefinedType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isNullOrUndefinedType | SonarJS linter helper functions

    Function isNullOrUndefinedType

    • isNullOrUndefinedType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isNumber.html b/typedoc/functions/isNumber.html index ca181b85ff..5b29c2863f 100644 --- a/typedoc/functions/isNumber.html +++ b/typedoc/functions/isNumber.html @@ -1 +1 @@ -isNumber | SonarJS linter helper functions

    Function isNumber

    • isNumber(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isNumber | SonarJS linter helper functions

    Function isNumber

    • isNumber(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isNumberArray.html b/typedoc/functions/isNumberArray.html index 2e118ac914..f6abaccc16 100644 --- a/typedoc/functions/isNumberArray.html +++ b/typedoc/functions/isNumberArray.html @@ -1,4 +1,4 @@ isNumberArray | SonarJS linter helper functions

    Function isNumberArray

    • isNumberArray(type: Type, services: ParserServicesWithTypeInformation): 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 e0d0cab175..7a5bd8f0f7 100644 --- a/typedoc/functions/isNumberLiteral.html +++ b/typedoc/functions/isNumberLiteral.html @@ -1 +1 @@ -isNumberLiteral | SonarJS linter helper functions

    Function isNumberLiteral

    • isNumberLiteral(node: 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): 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 38113a471d..fcc25f9ded 100644 --- a/typedoc/functions/isNumberType.html +++ b/typedoc/functions/isNumberType.html @@ -1 +1 @@ -isNumberType | SonarJS linter helper functions

    Function isNumberType

    • isNumberType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isNumberType | SonarJS linter helper functions

    Function isNumberType

    • isNumberType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isObjectDestructuring.html b/typedoc/functions/isObjectDestructuring.html index 71cf8a13aa..8f43b36846 100644 --- a/typedoc/functions/isObjectDestructuring.html +++ b/typedoc/functions/isObjectDestructuring.html @@ -1 +1 @@ -isObjectDestructuring | SonarJS linter helper functions

    Function isObjectDestructuring

    • isObjectDestructuring(
          node: 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,
      ): 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 9b0c8c0801..e806c56b10 100644 --- a/typedoc/functions/isObjectType.html +++ b/typedoc/functions/isObjectType.html @@ -1 +1 @@ -isObjectType | SonarJS linter helper functions

    Function isObjectType

    • isObjectType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    +isObjectType | SonarJS linter helper functions

    Function isObjectType

    • isObjectType(__namedParameters: Type): number

    • Parameters

      • __namedParameters: Type

      Returns number

    Settings

    diff --git a/typedoc/functions/isPresentationTable.html b/typedoc/functions/isPresentationTable.html index 7c5b03aa51..75d828b914 100644 --- a/typedoc/functions/isPresentationTable.html +++ b/typedoc/functions/isPresentationTable.html @@ -1 +1 @@ -isPresentationTable | SonarJS linter helper functions

    Function isPresentationTable

    • isPresentationTable(context: RuleContext, node: JSXOpeningElement): boolean

    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    Settings

    +isPresentationTable | SonarJS linter helper functions

    Function isPresentationTable

    • isPresentationTable(context: RuleContext, node: JSXOpeningElement): boolean

    • Parameters

      • context: RuleContext
      • node: JSXOpeningElement

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isProperty.html b/typedoc/functions/isProperty.html index 2ea7cd4b19..0a1f6ba0da 100644 --- a/typedoc/functions/isProperty.html +++ b/typedoc/functions/isProperty.html @@ -1 +1 @@ -isProperty | SonarJS linter helper functions

    Function isProperty

    • isProperty(node: Node): node is Property

    • Parameters

      • node: Node

      Returns node is Property

    Settings

    +isProperty | SonarJS linter helper functions

    Function isProperty

    • isProperty(node: 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 333b7ad77d..b6591641cd 100644 --- a/typedoc/functions/isReferenceTo.html +++ b/typedoc/functions/isReferenceTo.html @@ -1 +1 @@ -isReferenceTo | SonarJS linter helper functions

    Function isReferenceTo

    • isReferenceTo(ref: Reference, node: Node): boolean

    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    Settings

    +isReferenceTo | SonarJS linter helper functions

    Function isReferenceTo

    • isReferenceTo(ref: Reference, node: Node): boolean

    • Parameters

      • ref: Reference
      • node: Node

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isRegexLiteral.html b/typedoc/functions/isRegexLiteral.html index 82f4fcdbca..3dd3d9898e 100644 --- a/typedoc/functions/isRegexLiteral.html +++ b/typedoc/functions/isRegexLiteral.html @@ -1 +1 @@ -isRegexLiteral | SonarJS linter helper functions

    Function isRegexLiteral

    • isRegexLiteral(node: Node): node is RegExpLiteral

    • Parameters

      • node: Node

      Returns node is RegExpLiteral

    Settings

    +isRegexLiteral | SonarJS linter helper functions

    Function isRegexLiteral

    • isRegexLiteral(node: 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 9e61ab36b8..6fd9ca4a25 100644 --- a/typedoc/functions/isRequire.html +++ b/typedoc/functions/isRequire.html @@ -1 +1 @@ -isRequire | SonarJS linter helper functions

    Function isRequire

    • isRequire(node: Node): node is CallExpression

    • Parameters

      Returns node is CallExpression

    Settings

    +isRequire | SonarJS linter helper functions

    Function isRequire

    • isRequire(node: Node): node is CallExpression

    • Parameters

      Returns node is CallExpression

    Settings

    diff --git a/typedoc/functions/isRequireModule.html b/typedoc/functions/isRequireModule.html index 6b384f11dc..9b1c1ea7b3 100644 --- a/typedoc/functions/isRequireModule.html +++ b/typedoc/functions/isRequireModule.html @@ -1 +1 @@ -isRequireModule | SonarJS linter helper functions

    Function isRequireModule

    • isRequireModule(node: CallExpression, ...moduleNames: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    +isRequireModule | SonarJS linter helper functions

    Function isRequireModule

    • isRequireModule(node: CallExpression, ...moduleNames: string[]): boolean

    • Parameters

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

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isRequiredParserServices.html b/typedoc/functions/isRequiredParserServices.html index 88676e8377..fd597d1029 100644 --- a/typedoc/functions/isRequiredParserServices.html +++ b/typedoc/functions/isRequiredParserServices.html @@ -1 +1 @@ -isRequiredParserServices | SonarJS linter helper functions

    Function isRequiredParserServices

    • isRequiredParserServices(
          services: undefined | ParserServices,
      ): services is ParserServicesWithTypeInformation

    • Parameters

      • services: undefined | ParserServices

      Returns services is ParserServicesWithTypeInformation

    Settings

    +isRequiredParserServices | SonarJS linter helper functions

    Function isRequiredParserServices

    • isRequiredParserServices(
          services: undefined | ParserServices,
      ): 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 2e990ca04f..31b4bae011 100644 --- a/typedoc/functions/isRoot.html +++ b/typedoc/functions/isRoot.html @@ -1 +1 @@ -isRoot | SonarJS linter helper functions

    Function isRoot

    • isRoot(file: string): boolean

    • Parameters

      • file: string

      Returns boolean

    Settings

    +isRoot | SonarJS linter helper functions

    Function isRoot

    • isRoot(file: string): boolean

    • Parameters

      • file: string

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isS3BucketConstructor.html b/typedoc/functions/isS3BucketConstructor.html index f7386edb0d..23bcd0817a 100644 --- a/typedoc/functions/isS3BucketConstructor.html +++ b/typedoc/functions/isS3BucketConstructor.html @@ -1,4 +1,4 @@ isS3BucketConstructor | SonarJS linter helper functions

    Function isS3BucketConstructor

    • isS3BucketConstructor(context: RuleContext, node: NewExpression): 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 1b8e5fa03d..852008e497 100644 --- a/typedoc/functions/isS3BucketDeploymentConstructor.html +++ b/typedoc/functions/isS3BucketDeploymentConstructor.html @@ -1,4 +1,4 @@ isS3BucketDeploymentConstructor | SonarJS linter helper functions

    Function isS3BucketDeploymentConstructor

    • isS3BucketDeploymentConstructor(
          context: RuleContext,
          node: NewExpression,
      ): 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 58c985d0f9..fd9f0fb8d8 100644 --- a/typedoc/functions/isSimpleRawString.html +++ b/typedoc/functions/isSimpleRawString.html @@ -1 +1 @@ -isSimpleRawString | SonarJS linter helper functions

    Function isSimpleRawString

    • isSimpleRawString(node: Node): node is TaggedTemplateExpression

    • Parameters

      • node: Node

      Returns node is TaggedTemplateExpression

    Settings

    +isSimpleRawString | SonarJS linter helper functions

    Function isSimpleRawString

    • isSimpleRawString(node: 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 b824383a34..b060049514 100644 --- a/typedoc/functions/isStaticTemplateLiteral.html +++ b/typedoc/functions/isStaticTemplateLiteral.html @@ -1 +1 @@ -isStaticTemplateLiteral | SonarJS linter helper functions

    Function isStaticTemplateLiteral

    • isStaticTemplateLiteral(node: Node): node is TemplateLiteral

    • Parameters

      • node: Node

      Returns node is TemplateLiteral

    Settings

    +isStaticTemplateLiteral | SonarJS linter helper functions

    Function isStaticTemplateLiteral

    • isStaticTemplateLiteral(node: 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 a6e7fee1d6..f1e1b491e0 100644 --- a/typedoc/functions/isString.html +++ b/typedoc/functions/isString.html @@ -1 +1 @@ -isString | SonarJS linter helper functions

    Function isString

    • isString(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isString | SonarJS linter helper functions

    Function isString

    • isString(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

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

    Function isStringArray

    • isStringArray(type: Type, services: ParserServicesWithTypeInformation): 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 cbfa53a13d..f7290aa429 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 e87df260b7..f2a74ede62 100644 --- a/typedoc/functions/isStringType.html +++ b/typedoc/functions/isStringType.html @@ -1 +1 @@ -isStringType | SonarJS linter helper functions

    Function isStringType

    • isStringType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

    +isStringType | SonarJS linter helper functions

    Function isStringType

    • isStringType(type: Type): boolean

    • Parameters

      • type: Type

      Returns boolean

    Settings

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

    Function isSupported

    • isSupported(dirname: string, minVersions: MinimumVersions): 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 3aaa19de3f..0c75bd0727 100644 --- a/typedoc/functions/isThenable.html +++ b/typedoc/functions/isThenable.html @@ -1 +1 @@ -isThenable | SonarJS linter helper functions

    Function isThenable

    • isThenable(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isThenable | SonarJS linter helper functions

    Function isThenable

    • isThenable(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isThisExpression.html b/typedoc/functions/isThisExpression.html index 5d51b3cee9..29cbb29111 100644 --- a/typedoc/functions/isThisExpression.html +++ b/typedoc/functions/isThisExpression.html @@ -1 +1 @@ -isThisExpression | SonarJS linter helper functions

    Function isThisExpression

    • isThisExpression(node: Node): node is ThisExpression

    • Parameters

      • node: Node

      Returns node is ThisExpression

    Settings

    +isThisExpression | SonarJS linter helper functions

    Function isThisExpression

    • isThisExpression(node: 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 44921dc3ed..ef9d7b9f9a 100644 --- a/typedoc/functions/isThrowStatement.html +++ b/typedoc/functions/isThrowStatement.html @@ -1 +1 @@ -isThrowStatement | SonarJS linter helper functions

    Function isThrowStatement

    • isThrowStatement(node: undefined | Node): node is ThrowStatement

    • Parameters

      • node: undefined | Node

      Returns node is ThrowStatement

    Settings

    +isThrowStatement | SonarJS linter helper functions

    Function isThrowStatement

    • isThrowStatement(node: undefined | 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 317fe075ee..f3c6f4eb1a 100644 --- a/typedoc/functions/isTypeAlias.html +++ b/typedoc/functions/isTypeAlias.html @@ -1,4 +1,4 @@ isTypeAlias | SonarJS linter helper functions

    Function isTypeAlias

    • isTypeAlias(node: TypeNode, context: RuleContext): 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 0825ee97c9..aee9711816 100644 --- a/typedoc/functions/isTypedArray.html +++ b/typedoc/functions/isTypedArray.html @@ -1,2 +1,2 @@ isTypedArray | SonarJS linter helper functions

    Function isTypedArray

    • isTypedArray(node: Node, services: ParserServicesWithTypeInformation): 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 074b19217e..be6f7e0713 100644 --- a/typedoc/functions/isUnaryExpression.html +++ b/typedoc/functions/isUnaryExpression.html @@ -1 +1 @@ -isUnaryExpression | SonarJS linter helper functions

    Function isUnaryExpression

    • isUnaryExpression(node: undefined | Node): node is UnaryExpression

    • Parameters

      • node: undefined | Node

      Returns node is UnaryExpression

    Settings

    +isUnaryExpression | SonarJS linter helper functions

    Function isUnaryExpression

    • isUnaryExpression(node: undefined | 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 bac3926cb1..65b065ac03 100644 --- a/typedoc/functions/isUndefined.html +++ b/typedoc/functions/isUndefined.html @@ -1 +1 @@ -isUndefined | SonarJS linter helper functions

    Function isUndefined

    Settings

    +isUndefined | SonarJS linter helper functions

    Function isUndefined

    Settings

    diff --git a/typedoc/functions/isUndefinedOrNull.html b/typedoc/functions/isUndefinedOrNull.html index 83b0a6db4b..401854f83e 100644 --- a/typedoc/functions/isUndefinedOrNull.html +++ b/typedoc/functions/isUndefinedOrNull.html @@ -1 +1 @@ -isUndefinedOrNull | SonarJS linter helper functions

    Function isUndefinedOrNull

    • isUndefinedOrNull(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isUndefinedOrNull | SonarJS linter helper functions

    Function isUndefinedOrNull

    • isUndefinedOrNull(
          node: Node,
          services: ParserServicesWithTypeInformation,
      ): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isUnion.html b/typedoc/functions/isUnion.html index 8367485ebe..609066e02e 100644 --- a/typedoc/functions/isUnion.html +++ b/typedoc/functions/isUnion.html @@ -1 +1 @@ -isUnion | SonarJS linter helper functions

    Function isUnion

    • isUnion(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    +isUnion | SonarJS linter helper functions

    Function isUnion

    • isUnion(node: Node, services: ParserServicesWithTypeInformation): boolean

    • Parameters

      • node: Node
      • services: ParserServicesWithTypeInformation

      Returns boolean

    Settings

    diff --git a/typedoc/functions/isUnresolved.html b/typedoc/functions/isUnresolved.html index 88e09a5457..6249187b15 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 3898dc2862..2c9d47cd7d 100644 --- a/typedoc/functions/isVariableDeclaration.html +++ b/typedoc/functions/isVariableDeclaration.html @@ -1 +1 @@ -isVariableDeclaration | SonarJS linter helper functions

    Function isVariableDeclaration

    • isVariableDeclaration(node: undefined | Node): node is VariableDeclaration

    • Parameters

      • node: undefined | Node

      Returns node is VariableDeclaration

    Settings

    +isVariableDeclaration | SonarJS linter helper functions

    Function isVariableDeclaration

    • isVariableDeclaration(node: undefined | 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 b540b1aa99..ba3417fbd3 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 1b54a21dd4..d46201bae8 100644 --- a/typedoc/functions/localAncestorsChain.html +++ b/typedoc/functions/localAncestorsChain.html @@ -1 +1 @@ -localAncestorsChain | SonarJS linter helper functions

    Function localAncestorsChain

    • localAncestorsChain(node: Node): Node[]

    • Parameters

      • node: Node

      Returns Node[]

    Settings

    +localAncestorsChain | SonarJS linter helper functions

    Function localAncestorsChain

    • localAncestorsChain(node: Node): Node[]

    • Parameters

      • node: Node

      Returns Node[]

    Settings

    diff --git a/typedoc/functions/lva.html b/typedoc/functions/lva.html index 9f821e36a2..9628f2c514 100644 --- a/typedoc/functions/lva.html +++ b/typedoc/functions/lva.html @@ -1 +1 @@ -lva | SonarJS linter helper functions

    Function lva

    Settings

    +lva | SonarJS linter helper functions

    Function lva

    Settings

    diff --git a/typedoc/functions/mergeRules.html b/typedoc/functions/mergeRules.html index fe8e29831c..76c9af5c78 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 0d3c5663ce..390ee081e6 100644 --- a/typedoc/functions/normalizeFQN.html +++ b/typedoc/functions/normalizeFQN.html @@ -1 +1 @@ -normalizeFQN | SonarJS linter helper functions

    Function normalizeFQN

    • normalizeFQN(fqn?: null | string): undefined | string

    • Parameters

      • Optionalfqn: null | string

      Returns undefined | string

    Settings

    +normalizeFQN | SonarJS linter helper functions

    Function normalizeFQN

    • normalizeFQN(fqn?: null | string): 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 27118e1e87..71c311725c 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 a336ae92b8..8adf44cf73 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 5f8bcc4a88..56ca2f3472 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 54ba3b17bf..e89a1e0cbe 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 0250808fcd..fb5ddf306a 100644 --- a/typedoc/functions/removeNodeWithLeadingWhitespaces.html +++ b/typedoc/functions/removeNodeWithLeadingWhitespaces.html @@ -1 +1 @@ -removeNodeWithLeadingWhitespaces | SonarJS linter helper functions

    Function removeNodeWithLeadingWhitespaces

    • removeNodeWithLeadingWhitespaces(
          context: RuleContext,
          node: Node,
          fixer: RuleFixer,
          removeUntil?: number,
      ): Fix

    • Parameters

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

      Returns Fix

    Settings

    +removeNodeWithLeadingWhitespaces | SonarJS linter helper functions

    Function removeNodeWithLeadingWhitespaces

    • removeNodeWithLeadingWhitespaces(
          context: RuleContext,
          node: Node,
          fixer: RuleFixer,
          removeUntil?: number,
      ): 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 23753cbd4b..a6dc8c2e5f 100644 --- a/typedoc/functions/report.html +++ b/typedoc/functions/report.html @@ -1,4 +1,4 @@ report | SonarJS linter helper functions

    Function report

    • report(
          context: RuleContext,
          reportDescriptor: ReportDescriptor,
          secondaryLocations?: IssueLocation[],
          cost?: number,
      ): 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 d2b7a4980a..ebbe7bfcc7 100644 --- a/typedoc/functions/resolveAssignedValues.html +++ b/typedoc/functions/resolveAssignedValues.html @@ -1 +1 @@ -resolveAssignedValues | SonarJS linter helper functions

    Function resolveAssignedValues

    • resolveAssignedValues(
          lhsVariable: Variable,
          writeExpr: null | Node,
          assignedValuesMap: Map<Variable, Values>,
          scope: 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: Variable,
          writeExpr: null | Node,
          assignedValuesMap: Map<Variable, Values>,
          scope: 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 06e0912b12..3fee7f5840 100644 --- a/typedoc/functions/resolveFromFunctionReference.html +++ b/typedoc/functions/resolveFromFunctionReference.html @@ -1 +1 @@ -resolveFromFunctionReference | SonarJS linter helper functions

    Function resolveFromFunctionReference

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

    • Parameters

      • context: RuleContext
      • functionIdentifier: Identifier

      Returns null | FunctionExpression | FunctionDeclaration

    Settings

    +resolveFromFunctionReference | SonarJS linter helper functions

    Function resolveFromFunctionReference

    • resolveFromFunctionReference(
          context: RuleContext,
          functionIdentifier: Identifier,
      ): 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 a94006b265..d40401bb0f 100644 --- a/typedoc/functions/resolveFunction.html +++ b/typedoc/functions/resolveFunction.html @@ -1 +1 @@ -resolveFunction | SonarJS linter helper functions

    Function resolveFunction

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

    • Parameters

      • context: RuleContext
      • node: Node

      Returns estree.Function | null

    Settings

    +resolveFunction | SonarJS linter helper functions

    Function resolveFunction

    • resolveFunction(context: RuleContext, node: 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 6e1f7c6812..c4b4c3a7d0 100644 --- a/typedoc/functions/resolveIdentifiers.html +++ b/typedoc/functions/resolveIdentifiers.html @@ -1 +1 @@ -resolveIdentifiers | SonarJS linter helper functions

    Function resolveIdentifiers

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

    • Parameters

      • node: Node
      • acceptShorthand: boolean = false

      Returns TSESTree.Identifier[]

    Settings

    +resolveIdentifiers | SonarJS linter helper functions

    Function resolveIdentifiers

    • resolveIdentifiers(node: Node, acceptShorthand?: boolean): 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 d6a2a9226a..c7c4c669ce 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 55bb561054..8a69558bfb 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 6f4e200110..a9882708d5 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[]): 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 f83cad0968..e274eb4f62 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 c776e7b148..04e0937262 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 7907128f67..d663dc191a 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): 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 ac66e77b01..5396ad45d5 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 35afbe35a4..da3a07838d 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 7017b73f63..e415145a48 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 336c4c0c8e..29f0171151 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 950bd89c97..79a068d1ef 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 ecf729ec24..8e1c3f7cca 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/types/AwsCdkCallback.html b/typedoc/types/AwsCdkCallback.html index 0506d59451..ca7d12380b 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;
    }

    Type declaration

    • OptionalfunctionName?: string
    • Optionalmethods?: string[]
    • callExpression:function
      • callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void

      • Parameters

        • expr: CallExpression
        • ctx: RuleContext
        • Optionalfqn: string

        Returns void

    • newExpression?:function
      • newExpression(expr: NewExpression, ctx: RuleContext): void

      • Parameters

        • expr: NewExpression
        • ctx: RuleContext

        Returns 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;
    }

    Type declaration

    • OptionalfunctionName?: string
    • Optionalmethods?: string[]
    • callExpression:function
      • callExpression(expr: CallExpression, ctx: RuleContext, fqn?: string): void

      • Parameters

        • expr: CallExpression
        • ctx: RuleContext
        • Optionalfqn: string

        Returns void

    • newExpression?:function
      • newExpression(expr: NewExpression, ctx: RuleContext): void

      • Parameters

        • expr: NewExpression
        • ctx: RuleContext

        Returns void

    Settings

    diff --git a/typedoc/types/AwsCdkConsumer.html b/typedoc/types/AwsCdkConsumer.html index 7611648911..75e4957fd4 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 96bfff5fe8..70e808ade9 100644 --- a/typedoc/types/AwsCdkConsumerMap.html +++ b/typedoc/types/AwsCdkConsumerMap.html @@ -1 +1 @@ -AwsCdkConsumerMap | SonarJS linter helper functions

    Type Alias AwsCdkConsumerMap

    AwsCdkConsumerMap: { [key: string]: AwsCdkConsumer }

    Type declaration

    Settings

    +AwsCdkConsumerMap | SonarJS linter helper functions

    Type Alias AwsCdkConsumerMap

    AwsCdkConsumerMap: { [key: string]: AwsCdkConsumer }

    Type declaration

    Settings

    diff --git a/typedoc/types/ContextOverrider.html b/typedoc/types/ContextOverrider.html index 8fe0fbdc65..a8ce0e5f6e 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

    Type declaration

      • (context: Rule.RuleContext, onReport: ReportOverrider): Rule.RuleContext

      • Parameters

        Returns Rule.RuleContext

    Settings

    +ContextOverrider | SonarJS linter helper functions

    Type Alias ContextOverrider

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

    Type declaration

      • (context: Rule.RuleContext, onReport: ReportOverrider): Rule.RuleContext

      • Parameters

        Returns Rule.RuleContext

    Settings

    diff --git a/typedoc/types/FullyQualifiedName.html b/typedoc/types/FullyQualifiedName.html index 6e5b801d2a..c6966d0c59 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 f2d97afbbb..b5fc049e50 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 bab894939d..0f3bc6708e 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 b1384c7ae4..4f350a37c0 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/NamedDependency.html b/typedoc/types/NamedDependency.html index dcfc4ecbe0..ef1716274d 100644 --- a/typedoc/types/NamedDependency.html +++ b/typedoc/types/NamedDependency.html @@ -1 +1 @@ -NamedDependency | SonarJS linter helper functions

    Type Alias NamedDependency

    NamedDependency: { name: string; version?: string }

    Type declaration

    • name: string
    • Optionalversion?: string

    Settings

    +NamedDependency | SonarJS linter helper functions

    Type Alias NamedDependency

    NamedDependency: { name: string; version?: string }

    Type declaration

    • name: string
    • Optionalversion?: string

    Settings

    diff --git a/typedoc/types/Node.html b/typedoc/types/Node.html index 0e0b8e84bf..98745f2e54 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 a19acaf06c..72d99d7bb0 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

    Type declaration

      • (context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor): void

      • Parameters

        • context: Rule.RuleContext
        • reportDescriptor: Rule.ReportDescriptor

        Returns void

    Settings

    +ReportOverrider | SonarJS linter helper functions

    Type Alias ReportOverrider

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

    Type declaration

      • (context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor): void

      • Parameters

        • context: Rule.RuleContext
        • reportDescriptor: Rule.ReportDescriptor

        Returns void

    Settings

    diff --git a/typedoc/types/RequiredParserServices.html b/typedoc/types/RequiredParserServices.html index 92e30a05bb..446380d300 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 028c73cd3a..5aa1edf43f 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 38139cba31..f777af2101 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 20badb1a19..4c85fec5fe 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 89217ff662..2a886aaa82 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 316f04c8cb..7302e3f84d 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 8135b48db2..7d0d62145b 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 5ec1b4a26f..bdeee9b2ab 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 f2ecbcbbf6..75b33c7280 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 6b37d1563a..f9a4d4ab73 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 4a1d09e1b4..51f7051492 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 81fc50a00b..6da1a557b9 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 0986c7c9db..e5a67605df 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 0a0d917a80..016b71a77f 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[];
    } = ...

    Type declaration

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

    Type declaration

    • 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 6bed84c09c..2a3db353d2 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 af1449b490..d8bd2a77bf 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 f34ba666a9..3f91d8acd2 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