Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rule

Hierarchy

  • TypedRule
    • Rule

Implements

  • IRule
  • ITypedRule

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • new Rule(options: IOptions): Rule

  • Parameters

    • options: IOptions

    Returns Rule

Properties

Protected ruleArguments

ruleArguments: any[]

ruleName

ruleName: string

Protected ruleSeverity

ruleSeverity: RuleSeverity

Methods

apply

  • apply(): RuleFailure[]

  • Returns RuleFailure[]

Protected applyWithFunction

  • applyWithFunction(sourceFile: SourceFile, walkFn: function): RuleFailure[]
  • applyWithFunction<T>(sourceFile: SourceFile, walkFn: function, options: NoInfer<T>): RuleFailure[]
  • applyWithFunction<T, U>(sourceFile: SourceFile, walkFn: function, options: NoInfer<T>, checker: NoInfer<U>): RuleFailure[]

  • Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext<void>): void

        • Parameters

          • ctx: WalkContext<void>

          Returns void

    Returns RuleFailure[]

  • Type parameters

    • T

    Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext<T>): void

        • Parameters

          • ctx: WalkContext<T>

          Returns void

    • options: NoInfer<T>

    Returns RuleFailure[]

  • Type parameters

    • T

    • U

    Parameters

    • sourceFile: SourceFile
    • walkFn: function
        • (ctx: WalkContext<T>, programOrChecker: U): void

        • Parameters

          • ctx: WalkContext<T>
          • programOrChecker: U

          Returns void

    • options: NoInfer<T>
    • checker: NoInfer<U>

    Returns RuleFailure[]

applyWithProgram

  • applyWithProgram(sourceFile: SourceFile, program: Program): RuleFailure[]

applyWithWalker

  • applyWithWalker(walker: IWalker): RuleFailure[]

  • Parameters

    • walker: IWalker

    Returns RuleFailure[]

Protected filterFailures

  • filterFailures(failures: RuleFailure[]): RuleFailure[]
  • deprecated

    Failures will be filtered based on tslint:disable comments by tslint. This method now does nothing.

    Parameters

    • failures: RuleFailure[]

    Returns RuleFailure[]

getOptions

  • getOptions(): IOptions

  • Returns IOptions

isEnabled

  • isEnabled(): boolean

  • Returns boolean

Object literals

Static metadata

metadata: object

description

description: string = "Enforces that `.pipe(..., takeUntil(...))` is called before `.subscribe()`."

options

options: null = null

optionsDescription

optionsDescription: string = "Not configurable."

requiresTypeInfo

requiresTypeInfo: true = true

ruleName

ruleName: string = "w11k-rxjs-subscribe-takeuntil"

type

type: "style" = "style"

typescriptOnly

typescriptOnly: true = true

Generated using TypeDoc