Class ComponentLinter

Index

Constructors

Accessors

Methods

lintComponent LintComponent validateComponentSyntax ValidateComponentSyntax

Constructors

constructor

new ComponentLinter(): ComponentLinter
Returns ComponentLinter

Accessors

`Static`SqlDialect

get SqlDialect(): SQLParserDialect
Current SQL dialect used for WHERE clause parsing

Returns SQLParserDialect
- Defined in React/linter/src/component-linter.ts:105

Methods

`Static`lintComponent

lintComponent(
    code: string,
    componentName: string,
    componentSpec?: ComponentSpec,
    isRootComponent?: boolean,
    contextUser?: UserInfo,
    debugMode?: boolean,
    options?: LinterOptions,
    sqlDialect?: SQLParserDialect,
): Promise<LintResult>
Parameters
- code: string
- componentName: string
- OptionalcomponentSpec: ComponentSpec
- OptionalisRootComponent: boolean
- OptionalcontextUser: UserInfo
- OptionaldebugMode: boolean
- Optionaloptions: LinterOptions
- OptionalsqlDialect: SQLParserDialect
Returns Promise<LintResult>
Deprecated
Use LintComponent.
- Defined in React/linter/src/component-linter.ts:355

`Static`LintComponent

LintComponent(
    code: string,
    componentName: string,
    componentSpec?: ComponentSpec,
    isRootComponent?: boolean,
    contextUser?: UserInfo,
    debugMode?: boolean,
    options?: LinterOptions,
    sqlDialect?: SQLParserDialect,
): Promise<LintResult>
Parameters
- code: string
- componentName: string
- OptionalcomponentSpec: ComponentSpec
- OptionalisRootComponent: boolean
- OptionalcontextUser: UserInfo
- OptionaldebugMode: boolean
- Optionaloptions: LinterOptions
- OptionalsqlDialect: SQLParserDialect
Returns Promise<LintResult>
- Defined in React/linter/src/component-linter.ts:109

`Static`validateComponentSyntax

validateComponentSyntax(
code: string,
componentName: string,
): Promise<{ errors: string[]; valid: boolean }>
Parameters
- code: string
- componentName: string
Returns Promise<{ errors: string[]; valid: boolean }>
Deprecated
Use ValidateComponentSyntax.
- Defined in React/linter/src/component-linter.ts:94

`Static`ValidateComponentSyntax

ValidateComponentSyntax(
code: string,
componentName: string,
): Promise<{ errors: string[]; valid: boolean }>
Parameters
- code: string
- componentName: string
Returns Promise<{ errors: string[]; valid: boolean }>
- Defined in React/linter/src/component-linter.ts:58