From 9be0b92e34508759bda9c3516fa39443956936c7 Mon Sep 17 00:00:00 2001 From: zglicz Date: Thu, 19 Dec 2024 10:23:18 +0000 Subject: [PATCH] Update the bridge helper functions site --- typedoc/classes/LiveVariables.html | 14 +++++++------- typedoc/classes/ReachingDefinitions.html | 6 +++--- typedoc/functions/AwsCdkCheckArguments.html | 2 +- typedoc/functions/AwsCdkTemplate.html | 2 +- typedoc/functions/AwsIamPolicyTemplate.html | 2 +- typedoc/functions/Chai.isAssertion.html | 2 +- typedoc/functions/Chai.isImported.html | 2 +- .../Express.SensitiveMiddlewarePropertyRule.html | 2 +- .../functions/Express.attemptFindAppInjection.html | 2 +- .../Express.attemptFindAppInstantiation.html | 2 +- .../functions/Express.isMiddlewareInstance.html | 2 +- typedoc/functions/Express.isUsingMiddleware.html | 2 +- typedoc/functions/Mocha.extractTestCase.html | 2 +- typedoc/functions/Mocha.isDescribeCase.html | 2 +- typedoc/functions/Mocha.isTestCase.html | 2 +- typedoc/functions/Mocha.isTestConstruct.html | 2 +- typedoc/functions/S3BucketTemplate.html | 2 +- typedoc/functions/Sinon.isAssertion.html | 2 +- typedoc/functions/Sinon.isImported.html | 2 +- typedoc/functions/Vitest.isAssertion.html | 2 +- typedoc/functions/Vitest.isImported.html | 2 +- typedoc/functions/ancestorsChain.html | 2 +- typedoc/functions/areEquivalent.html | 2 +- typedoc/functions/checkSensitiveCall.html | 2 +- typedoc/functions/childrenOf.html | 2 +- typedoc/functions/clearDependenciesCache.html | 2 +- typedoc/functions/collectIfBranches.html | 2 +- typedoc/functions/collectSwitchBranches.html | 2 +- typedoc/functions/encodeContents.html | 2 +- typedoc/functions/expandMessage.html | 2 +- typedoc/functions/findFirstMatchingAncestor.html | 2 +- .../functions/findFirstMatchingLocalAncestor.html | 2 +- typedoc/functions/findParent.html | 2 +- typedoc/functions/findPropagatedSetting.html | 2 +- typedoc/functions/flatMap.html | 2 +- typedoc/functions/flattenArgs.html | 2 +- typedoc/functions/generateMeta.html | 2 +- typedoc/functions/getAllDependencies.html | 2 +- typedoc/functions/getBucketProperty.html | 2 +- typedoc/functions/getDependencies.html | 2 +- .../functions/getDependenciesFromPackageJson.html | 2 +- typedoc/functions/getElementType.html | 2 +- typedoc/functions/getFirstToken.html | 2 +- typedoc/functions/getFirstTokenAfter.html | 2 +- typedoc/functions/getFullyQualifiedName.html | 2 +- typedoc/functions/getFullyQualifiedNameRaw.html | 2 +- typedoc/functions/getImportDeclarations.html | 2 +- typedoc/functions/getJsxShortCircuitNodes.html | 2 +- typedoc/functions/getLhsVariable.html | 2 +- typedoc/functions/getLiteralValue.html | 2 +- .../functions/getMainFunctionTokenLocation.html | 2 +- typedoc/functions/getManifests.html | 2 +- typedoc/functions/getNodeParent.html | 2 +- typedoc/functions/getParent.html | 2 +- typedoc/functions/getProgramStatements.html | 2 +- typedoc/functions/getProperty.html | 2 +- typedoc/functions/getPropertyWithValue.html | 2 +- typedoc/functions/getRequireCalls.html | 2 +- typedoc/functions/getSensitiveEffect.html | 2 +- typedoc/functions/getSignatureFromCallee.html | 2 +- typedoc/functions/getSimpleRawStringValue.html | 2 +- typedoc/functions/getSymbolAtLocation.html | 2 +- typedoc/functions/getTypeAsString.html | 2 +- typedoc/functions/getTypeFromTreeNode.html | 2 +- typedoc/functions/getUnionTypes.html | 2 +- typedoc/functions/getUniqueWriteReference.html | 2 +- typedoc/functions/getUniqueWriteUsage.html | 2 +- typedoc/functions/getUniqueWriteUsageOrNode.html | 2 +- typedoc/functions/getValueOfExpression.html | 2 +- typedoc/functions/getVariableFromIdentifier.html | 2 +- typedoc/functions/getVariableFromName.html | 2 +- typedoc/functions/getVariableFromScope.html | 2 +- typedoc/functions/interceptReport.html | 2 +- typedoc/functions/interceptReportForReact.html | 2 +- typedoc/functions/isAny.html | 2 +- typedoc/functions/isAnyLiteral.html | 2 +- typedoc/functions/isArray.html | 2 +- typedoc/functions/isArrayExpression.html | 2 +- typedoc/functions/isArrayLikeType.html | 2 +- typedoc/functions/isArrowFunctionExpression.html | 2 +- typedoc/functions/isBigIntArray.html | 2 +- typedoc/functions/isBigIntType.html | 2 +- typedoc/functions/isBinaryPlus.html | 2 +- typedoc/functions/isBooleanLiteral.html | 2 +- typedoc/functions/isBooleanLiteralType.html | 2 +- typedoc/functions/isBooleanTrueType.html | 2 +- typedoc/functions/isBooleanType.html | 2 +- typedoc/functions/isCallingMethod.html | 2 +- typedoc/functions/isDefaultSpecifier.html | 2 +- typedoc/functions/isDotNotation.html | 2 +- typedoc/functions/isElementWrite.html | 2 +- typedoc/functions/isFalseLiteral.html | 2 +- typedoc/functions/isFunction.html | 2 +- typedoc/functions/isFunctionCall.html | 2 +- typedoc/functions/isFunctionDeclaration.html | 2 +- typedoc/functions/isFunctionExpression.html | 2 +- typedoc/functions/isFunctionInvocation.html | 2 +- typedoc/functions/isFunctionNode.html | 2 +- typedoc/functions/isGenericType.html | 2 +- typedoc/functions/isIdentifier.html | 2 +- typedoc/functions/isIfStatement.html | 2 +- typedoc/functions/isIndexNotation.html | 2 +- typedoc/functions/isInsideVueSetupScript.html | 2 +- typedoc/functions/isLiteral.html | 2 +- typedoc/functions/isLogicalExpression.html | 2 +- typedoc/functions/isMemberExpression.html | 2 +- typedoc/functions/isMemberWithProperty.html | 2 +- typedoc/functions/isMethodCall.html | 2 +- typedoc/functions/isMethodInvocation.html | 2 +- typedoc/functions/isModuleDeclaration.html | 2 +- typedoc/functions/isModuleExports.html | 2 +- typedoc/functions/isNamespaceSpecifier.html | 2 +- typedoc/functions/isNullLiteral.html | 2 +- typedoc/functions/isNullOrUndefinedType.html | 2 +- typedoc/functions/isNumber.html | 2 +- typedoc/functions/isNumberArray.html | 2 +- typedoc/functions/isNumberLiteral.html | 2 +- typedoc/functions/isNumberType.html | 2 +- typedoc/functions/isObjectDestructuring.html | 2 +- typedoc/functions/isObjectType.html | 2 +- typedoc/functions/isPresentationTable.html | 2 +- typedoc/functions/isProperty.html | 2 +- typedoc/functions/isReferenceTo.html | 2 +- typedoc/functions/isRegexLiteral.html | 2 +- typedoc/functions/isRequire.html | 2 +- typedoc/functions/isRequireModule.html | 2 +- typedoc/functions/isRequiredParserServices.html | 2 +- typedoc/functions/isRoot.html | 2 +- typedoc/functions/isS3BucketConstructor.html | 2 +- .../functions/isS3BucketDeploymentConstructor.html | 2 +- typedoc/functions/isSimpleRawString.html | 2 +- typedoc/functions/isStaticTemplateLiteral.html | 2 +- typedoc/functions/isString.html | 2 +- typedoc/functions/isStringArray.html | 2 +- typedoc/functions/isStringLiteral.html | 2 +- typedoc/functions/isStringType.html | 2 +- typedoc/functions/isSupported.html | 2 +- typedoc/functions/isThenable.html | 2 +- typedoc/functions/isThisExpression.html | 2 +- typedoc/functions/isThrowStatement.html | 2 +- typedoc/functions/isTypeAlias.html | 2 +- typedoc/functions/isTypedArray.html | 2 +- typedoc/functions/isUnaryExpression.html | 2 +- typedoc/functions/isUndefined.html | 2 +- typedoc/functions/isUndefinedOrNull.html | 2 +- typedoc/functions/isUnion.html | 2 +- typedoc/functions/isUnresolved.html | 2 +- typedoc/functions/isVariableDeclaration.html | 2 +- typedoc/functions/last.html | 2 +- typedoc/functions/localAncestorsChain.html | 2 +- typedoc/functions/lva.html | 2 +- typedoc/functions/mergeRules.html | 2 +- typedoc/functions/normalizeFQN.html | 2 +- typedoc/functions/reachingDefinitions-1.html | 2 +- typedoc/functions/readFileSync.html | 2 +- typedoc/functions/reduceTo.html | 2 +- typedoc/functions/reduceToIdentifier.html | 2 +- .../removeNodeWithLeadingWhitespaces.html | 2 +- typedoc/functions/report.html | 2 +- typedoc/functions/resolveAssignedValues.html | 2 +- .../functions/resolveFromFunctionReference.html | 2 +- typedoc/functions/resolveFunction.html | 2 +- typedoc/functions/resolveIdentifiers.html | 2 +- typedoc/functions/searchFiles.html | 2 +- typedoc/functions/stripBOM.html | 2 +- typedoc/functions/takeWithoutBreak.html | 2 +- typedoc/functions/toEncodedMessage.html | 2 +- typedoc/functions/toSecondaryLocation.html | 2 +- typedoc/functions/toUnixPath.html | 2 +- typedoc/interfaces/EncodedMessage.html | 4 ++-- typedoc/interfaces/File.html | 4 ++-- typedoc/interfaces/IssueLocation.html | 4 ++-- typedoc/interfaces/Mocha.TestCase.html | 4 ++-- typedoc/interfaces/PolicyCheckerOptions.html | 4 ++-- typedoc/interfaces/ReferenceLike.html | 4 ++-- typedoc/types/AwsCdkCallback.html | 2 +- typedoc/types/AwsCdkConsumer.html | 2 +- typedoc/types/AwsCdkConsumerMap.html | 2 +- typedoc/types/ContextOverrider.html | 2 +- typedoc/types/FullyQualifiedName.html | 2 +- typedoc/types/FunctionNodeType.html | 2 +- typedoc/types/LocationHolder.html | 2 +- typedoc/types/LoopLike.html | 2 +- typedoc/types/NamedDependency.html | 2 +- typedoc/types/Node.html | 2 +- typedoc/types/ReportOverrider.html | 2 +- typedoc/types/RequiredParserServices.html | 2 +- typedoc/types/RuleContext.html | 2 +- typedoc/types/StringLiteral.html | 2 +- typedoc/types/Values.html | 2 +- typedoc/variables/FUNCTION_NODES.html | 2 +- typedoc/variables/PACKAGE_JSON.html | 2 +- typedoc/variables/SONAR_RUNTIME.html | 2 +- typedoc/variables/TYPED_ARRAY_TYPES.html | 2 +- typedoc/variables/UTILITY_TYPES.html | 2 +- typedoc/variables/collectionConstructor.html | 2 +- typedoc/variables/copyingSortLike.html | 2 +- typedoc/variables/detectReactRule.html | 2 +- typedoc/variables/functionLike.html | 2 +- typedoc/variables/globalsByLibraries.html | 2 +- typedoc/variables/sortLike.html | 2 +- typedoc/variables/unknownValue.html | 2 +- typedoc/variables/writingMethods.html | 2 +- 203 files changed, 217 insertions(+), 217 deletions(-) diff --git a/typedoc/classes/LiveVariables.html b/typedoc/classes/LiveVariables.html index 5b7bebf355..83d1de80ea 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 d95b1818e3..24ee005bd6 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 8dc02a1d2c..fda1eb0e7a 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 9f39471e89..2d3137a59c 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 a70d3b3986..71c2829f9e 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 174ee7cf9c..ccffb4833b 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 28dec932dc..98d27204aa 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 1b5a35b4a3..bf346984d8 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 91d8ccc7d5..b43fdf2adb 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 1ea9e35bb8..f7e17a5063 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 d510b73815..b70e7fb3b0 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 2854fc420b..fc74044414 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 e5e7999826..bf68fb9492 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 d50eb69e5c..51d14a3572 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 a87d98179d..45a6f73f72 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 5deb0773e9..3ad0ace364 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 cf3c1fe112..2570817c31 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 924b80f1e1..d07bc998ed 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 c41f4d3efb..61bfc80e3c 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 0c19a9c7c7..7ca29d7142 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 fc2453073c..a4028d286f 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 43e004461b..5de0723b10 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 a7917d0f26..5e46b6d4de 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 c39415b052..525bcbaaab 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 da7865018f..7c18024b5c 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 911910a4ee..457735c340 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 8d5804e1c2..12c7738c3b 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 82c35e72f2..a40d587174 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 4fa1aa8759..09327afa5c 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 7dcec427d8..fbfe7b66f7 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 c8a3d42bf1..331142c4ce 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 bae1ce2a20..fd0014ad22 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 c1a5338c04..4503dd6d84 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 027534793f..2f1728aeb8 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 74f4319bbe..fa314ac2a7 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 b1d1544168..42df95eb26 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 2e295f574b..3e129b8bd6 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 0546f3598b..5e1337d383 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 127697c655..a891131bd4 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 d4f08d2647..64e711f946 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 d0d8bb285f..61a1f826c9 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 b4ae675c57..7bfbc70873 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 d4b89c4d94..1ac814c5d6 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 17088ff68d..7398bb1d45 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 f582bc7d7b..efcc68568c 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 7ad1205c7d..056c393ff7 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 dbacd58a36..4739ca5e0b 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 4732c41b26..684e238d88 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 e6428976f4..6d3f62858e 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 30c3cbd8d8..3224fcabf5 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 37db6c09c0..a985e81d06 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 176b1619eb..13f7bf346e 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 5fc01b9f09..747211ff47 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 7a128124ff..f26cd46b5d 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 7d6704eb49..b8a33ecf60 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 bb096aa40c..9c70fd5e24 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 e01aeb8f3d..8d7f42e2c2 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 cab2258331..37756d108c 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 2ea25e3c3a..e92c5c937a 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 3132ce066f..89c47d1fbd 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 41a1786f95..ed6b32a4ea 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 d0dcc5e62f..fb4f06b726 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 4a47bddf5f..eec6c630ba 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 03572a4c3d..0fbb3dc31d 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 b55596095d..c54f5d16a8 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 3c0e141647..61c287cefb 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 56cd12c74e..164983fac5 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 2b98944396..67b8515ab6 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 418f0a94ba..c4f1550a7a 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 7fd45c6cae..033690140a 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 e7bc6640ae..9d20487332 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 a9b6249fd5..c041170676 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 366ec61e3c..b817a4d7ed 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 7b34f33c57..0a683c68bd 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 18b621bc01..93f4abea28 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 4cb760fdc2..0016adbd6e 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 6f91b82445..3fb981a293 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 3cbf84c369..2e1f365ce3 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 6ff0dedc87..1520c2ffb5 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 bf52858c3a..5f514015b5 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 3004b0093e..a53ee56232 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 98b25eb856..a544715b46 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 d64b5f0679..c91c8eec24 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 5536a364ce..1f515f9aa6 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 a522fe2a49..685c37080f 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 273678f7d9..ae543b536a 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 3399884fc4..ae43e78e0d 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 2414521072..95d8b6ac8c 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 fbdb596edb..de1b3fea75 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 fb1ae6e6b3..100878d4bd 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 6cd1cbf2ba..9e2faac6a8 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 78b8b60a23..b215782a25 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 d02201beec..328de4e368 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 a8c1d6107c..969a9e9a05 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 4ce5bfd135..ef2dc7996d 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 edbb25e0d5..20b097ccef 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 1874c1c524..b5f83b645d 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 f1d346ba6d..7f491ba578 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 cb782d2a3b..5c56a66fb3 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 772418b0da..d94074e66d 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 dda65ac282..c6ee06b65c 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 73635690e3..ffce569467 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 535db67c77..dc4360b8e8 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 51bbf93b01..ee0d48565e 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 9604461327..805768917c 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 328ee5b76d..3e3678c55b 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 5346d59156..b745f5881d 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 a3f11ece6e..12ee2a526f 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 84fd8fa46d..65f85baa6e 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 d311e956e9..65deb09daf 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 f97e803389..a1beb34342 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 778723b912..b10ef0eeaf 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 659acb5c1c..66b1503eda 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 8497e5028b..b153a3e3c8 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 a68aeadf07..8a540df68c 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 97812f3f73..f1f70d2093 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 e0460df27e..d670da3959 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 d0d8715101..a7450b52a0 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 d8467dd345..17b7f81bb7 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 288953ba8c..812e267e17 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 228ec65ce8..d23e5eaa46 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 82bdb4842a..816fc3ead3 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 cbec4d5849..ef86e1941e 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 30936d6ad3..b8a6b9a3cc 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 c0b48d0ac8..468ef8b682 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 79ba0c8db6..d10db6481e 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 afb712a173..65db934d17 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 a7b9108360..c222154a26 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 c01d59e7b2..3e5560b512 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 66eb533a10..dcfe57b4cb 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 ed6856e5fe..a212f647cb 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 831353fd4f..e56adfb859 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 7356c3f4c4..034e148373 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 dfadc181e7..a79d3a78a3 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 c42c1ec0a4..9bc97937da 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 82ec918496..7e1460568f 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 cd94b335ce..4b5c7674a1 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 3bffa7ba90..eba39f96e5 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 fbbbd2aa06..7c4cea6172 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 2423bd8ea5..958889e5fe 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 cec6d80d8d..16b1e27b2a 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 ce1545b4b4..5a70358079 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 fcfd1908c6..38c333958e 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 e2ea13c46d..aab998e663 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 aac8b248d1..f4528154de 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 0402e45d9a..84d9aa23da 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 c4524f1c90..ba1aa813b0 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 8d374ae050..50f65d08a8 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 79a6f4097e..25cc1123e5 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 2960ef4464..be55c507aa 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 d8ce94e045..0f074e9771 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 d75ec842d7..8612c5a888 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 8b89d48b84..68d3f94497 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 99b2aa1594..1fc805bee9 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 465aa1baf0..8dcfad4aaf 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 6541eabab2..06492b191e 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 87e99966c7..487dbcd654 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 98987a16e1..bf9c206f12 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 f4254fa083..1c2a4d349c 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 15ee110c8e..eb10c33a27 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 fb72736281..577d3fd14d 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 6a0bbfd273..f74a55b198 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 f89b8771a2..35471827d2 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 78c22ce1ba..b651948dc0 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 503dfbc6e6..3a5b003a59 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 f991ba2b26..4a8e98cce1 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 e5ad54ee94..987c6d3340 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 e1303642f9..25298f3205 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 fa2dbe81eb..080a35fbfc 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 9a92c51e36..bc4e665290 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 514fe1bfe5..2f3d428ad9 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 e1c0824a95..97d3156924 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 27e90594c0..4f5a688649 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 f0aefe5ea1..ccc33524f0 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 04c3397a3e..7917c2c121 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 2fb948c214..c750a2897b 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 94db39b915..90d56c314a 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 60bafb66be..1ace7e62bb 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 f8b63708fc..cf03eaa70e 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 e4db422544..830fdd6074 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 db2ef1995f..067a46e630 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 3e3bd2d5fe..5263bd4308 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 63baf72a53..c30a28af02 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 a260be2a43..5385461a2e 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 866ff1e5c7..61b2c76a18 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 046db11aa5..307743416a 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 f0b41541f7..220626d178 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 96d97ba6c9..3e97888884 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 0fad9e57e2..697d1a9d09 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 213fd47273..890ffc862b 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 a04bde91d1..1879f645d8 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 b689f00551..8a31fdc5b2 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 bc51c24c57..48c340e996 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 7f89abe12d..df4e722eca 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 2f17cd5fab..82b8347054 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 411ce18cc4..008356a8b3 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 537ea822f6..03db70753e 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 9d0527abae..76c07963c6 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 70607db36c..c7aca47325 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 ffd53a5a48..d5216fe22b 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 ada36914d3..2f5fdd6b70 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 9a5117c28a..f83754f46e 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 0ce5b82065..f1f72d79aa 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