aboutsummaryrefslogtreecommitdiff
path: root/node_modules/tslint/lib/rules/completedDocsRule.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/tslint/lib/rules/completedDocsRule.d.ts')
-rw-r--r--node_modules/tslint/lib/rules/completedDocsRule.d.ts38
1 files changed, 25 insertions, 13 deletions
diff --git a/node_modules/tslint/lib/rules/completedDocsRule.d.ts b/node_modules/tslint/lib/rules/completedDocsRule.d.ts
index 560f436e7..67c76d562 100644
--- a/node_modules/tslint/lib/rules/completedDocsRule.d.ts
+++ b/node_modules/tslint/lib/rules/completedDocsRule.d.ts
@@ -1,16 +1,6 @@
import * as ts from "typescript";
import * as Lint from "../index";
-export interface IBlockRequirementDescriptor {
- visibilities?: Visibility[];
-}
-export interface IClassRequirementDescriptor {
- locations?: Location[];
- privacies?: Privacy[];
-}
-export declare type RequirementDescriptor = IBlockRequirementDescriptor | IClassRequirementDescriptor;
-export interface IRequirementDescriptors {
- [type: string]: RequirementDescriptor;
-}
+import { IInputExclusionDescriptors } from "./completed-docs/exclusionDescriptors";
export declare const ALL = "all";
export declare const ARGUMENT_CLASSES = "classes";
export declare const ARGUMENT_ENUMS = "enums";
@@ -22,6 +12,7 @@ export declare const ARGUMENT_NAMESPACES = "namespaces";
export declare const ARGUMENT_PROPERTIES = "properties";
export declare const ARGUMENT_TYPES = "types";
export declare const ARGUMENT_VARIABLES = "variables";
+export declare const DESCRIPTOR_TAGS = "tags";
export declare const DESCRIPTOR_LOCATIONS = "locations";
export declare const DESCRIPTOR_PRIVACIES = "privacies";
export declare const DESCRIPTOR_VISIBILITIES = "visibilities";
@@ -30,6 +21,8 @@ export declare const LOCATION_STATIC = "static";
export declare const PRIVACY_PRIVATE = "private";
export declare const PRIVACY_PROTECTED = "protected";
export declare const PRIVACY_PUBLIC = "public";
+export declare const TAGS_FOR_CONTENT = "content";
+export declare const TAGS_FOR_EXISTENCE = "exists";
export declare const VISIBILITY_EXPORTED = "exported";
export declare const VISIBILITY_INTERNAL = "internal";
export declare type All = typeof ALL;
@@ -39,10 +32,19 @@ export declare type Privacy = All | typeof PRIVACY_PRIVATE | typeof PRIVACY_PROT
export declare type Visibility = All | typeof VISIBILITY_EXPORTED | typeof VISIBILITY_INTERNAL;
export declare class Rule extends Lint.Rules.TypedRule {
static FAILURE_STRING_EXIST: string;
- static defaultArguments: DocType[];
+ static defaultArguments: IInputExclusionDescriptors;
static ARGUMENT_DESCRIPTOR_BLOCK: {
properties: {
[x: string]: {
+ properties: {
+ [x: string]: {
+ items: {
+ type: string;
+ };
+ type: string;
+ };
+ };
+ } | {
enum: string[];
type: string;
};
@@ -52,6 +54,15 @@ export declare class Rule extends Lint.Rules.TypedRule {
static ARGUMENT_DESCRIPTOR_CLASS: {
properties: {
[x: string]: {
+ properties: {
+ [x: string]: {
+ items: {
+ type: string;
+ };
+ type: string;
+ };
+ };
+ } | {
enum: string[];
type: string;
};
@@ -59,6 +70,7 @@ export declare class Rule extends Lint.Rules.TypedRule {
type: string;
};
static metadata: Lint.IRuleMetadata;
+ private readonly exclusionFactory;
applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[];
- private getRequirements(ruleArguments);
+ private getExclusionsMap(ruleArguments);
}