External module "src/raml1/ast.core/linter"

Index

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ASTNodeImpl

ASTNodeImpl: ASTNodeImpl

ASTPropImpl

ASTPropImpl: ASTPropImpl

Error

Error: yaml.Error

Variables

MAX_RECURSION_LEVEL

MAX_RECURSION_LEVEL: number

changeCase

changeCase: any

loophole

loophole: any

mediaTypeParser

mediaTypeParser: any

parameterPropertyToName

parameterPropertyToName: object

Type declaration

pluralize

pluralize: any

settings

settings: LinterSettings

stringify

stringify: any

su

su: any

typeToName

typeToName: object

Type declaration

Functions

actualSegments

actualSegments(rootPath: string): Array<string>

- Defined in src/raml1/ast.core/linter.ts:737
Parameters
- rootPath: string
Returns Array<string>

calculateExceeding

calculateExceeding(rootPath: string, relativePath: string): number

- Defined in src/raml1/ast.core/linter.ts:751
Parameters
- rootPath: string
- relativePath: string
Returns number

checkIfDomainIsUserDefined

checkIfDomainIsUserDefined(d: IProperty): boolean

- Defined in src/raml1/ast.core/linter.ts:236
Parameters
- d: IProperty
Returns boolean

checkPropertyQuard

checkPropertyQuard(n: IAttribute | IHighLevelNode, v: ValidationAcceptor): IProperty

- Defined in src/raml1/ast.core/linter.ts:89
Parameters
- n: IAttribute | IHighLevelNode
- v: ValidationAcceptor
Returns IProperty

checkReference

checkReference(pr: Property, astNode: IAttribute, vl: string, cb: ValidationAcceptor): boolean

- Defined in src/raml1/ast.core/linter.ts:1563
Parameters
- pr: Property
- astNode: IAttribute
- vl: string
- cb: ValidationAcceptor
Returns boolean

checkResourceTypeReference

checkResourceTypeReference(property: Property, astNode: IAttribute, acceptor: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:1719
Parameters
- property: Property
- astNode: IAttribute
- acceptor: ValidationAcceptor
Returns void

checkTraitReference

checkTraitReference(property: Property, astNode: IAttribute, acceptor: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:1672
Parameters
- property: Property
- astNode: IAttribute
- acceptor: ValidationAcceptor
Returns void

cleanupIncludesFlag

cleanupIncludesFlag(node: IParseResult, v: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:667
Parameters
- node: IParseResult
- v: ValidationAcceptor
Returns void

contentProvider

contentProvider(lowLevel: any): ContentProvider

- Defined in src/raml1/ast.core/linter.ts:2803
Parameters
- lowLevel: any
Returns ContentProvider

createIssue

createIssue(c: IssueCode, message: string, node: IParseResult, w?: boolean): ValidationIssue

- Defined in src/raml1/ast.core/linter.ts:3506
Parameters
- c: IssueCode
- message: string
- node: IParseResult
- Default value w: boolean = false
Returns ValidationIssue

createLLIssue

createLLIssue(issueCode: IssueCode, message: string, node: ILowLevelASTNode, rootCalculationAnchor: IParseResult, isWarning?: boolean, p?: boolean): ValidationIssue

- Defined in src/raml1/ast.core/linter.ts:3555
Parameters
- issueCode: IssueCode
- message: string
- node: ILowLevelASTNode
- rootCalculationAnchor: IParseResult
- Default value isWarning: boolean = false
- Default value p: boolean = false
Returns ValidationIssue

createLibraryIssue

createLibraryIssue(attr: IAttribute, hlNode: IHighLevelNode): ValidationIssue

- Defined in src/raml1/ast.core/linter.ts:483
Parameters
- attr: IAttribute
- hlNode: IHighLevelNode
Returns ValidationIssue

evalInSandbox

evalInSandbox(code: string, thisArg: any, args: any[]): any

- Defined in src/raml1/ast.core/linter.ts:64
Parameters
- code: string
- thisArg: any
- args: any[]
Returns any

extractLowLevelNode

extractLowLevelNode(e: IStatus): ILowLevelASTNode

- Defined in src/raml1/ast.core/linter.ts:2144
Parameters
- e: IStatus
Returns ILowLevelASTNode

findElementAtPath

findElementAtPath(n: IParseResult, p: IValidationPath): IParseResult

- Defined in src/raml1/ast.core/linter.ts:2152
Parameters
- n: IParseResult
- p: IValidationPath
Returns IParseResult

getHumanReadableNodeName

getHumanReadableNodeName(astNode: IParseResult): any

- Defined in src/raml1/ast.core/linter.ts:1501
Parameters
- astNode: IParseResult
Returns any

getMediaType

getMediaType(node: IAttribute): any

- Defined in src/raml1/ast.core/linter.ts:3370
Parameters
- node: IAttribute
Returns any

getMediaType2

getMediaType2(node: IAttribute): string

- Defined in src/raml1/ast.core/linter.ts:3381
Parameters
- node: IAttribute
Returns string

hasTemplateArgs

hasTemplateArgs(node: ILowLevelASTNode): boolean

- Defined in src/raml1/ast.core/linter.ts:468
Parameters
- node: ILowLevelASTNode
Returns boolean

isDefaultValueProp

isDefaultValueProp(d: IProperty): boolean

- Defined in src/raml1/ast.core/linter.ts:224
Parameters
- d: IProperty
Returns boolean

isDuplicateSibling

isDuplicateSibling(attr: IAttribute): boolean

- Defined in src/raml1/ast.core/linter.ts:1617
Parameters
- attr: IAttribute
Returns boolean

isExampleProp

isExampleProp(d: IProperty): boolean

- Defined in src/raml1/ast.core/linter.ts:230
Parameters
- d: IProperty
Returns boolean

isJson

isJson(s: string): boolean

- Defined in src/raml1/ast.core/linter.ts:3364
Parameters
- s: string
Returns boolean

isSecuredBy

isSecuredBy(d: IProperty): boolean

- Defined in src/raml1/ast.core/linter.ts:245
Parameters
- d: IProperty
Returns boolean

isTypeOrSchema

isTypeOrSchema(d: IProperty): boolean

- Defined in src/raml1/ast.core/linter.ts:221
Parameters
- d: IProperty
Returns boolean

isValid

isValid(t: ITypeDefinition, h: IHighLevelNode, value: any, p: IProperty, attr?: IAttribute): any

- Defined in src/raml1/ast.core/linter.ts:1046
Parameters
- t: ITypeDefinition
- h: IHighLevelNode
- value: any
- p: IProperty
- Optional attr: IAttribute
Returns any

isValidArray

isValidArray(t: ITypeDefinition, h: IHighLevelNode, v: any, p: IProperty, attr?: IAttribute): any

- Defined in src/raml1/ast.core/linter.ts:1055
Parameters
- t: ITypeDefinition
- h: IHighLevelNode
- v: any
- p: IProperty
- Optional attr: IAttribute
Returns any

isValidPropertyValue

isValidPropertyValue(pr: Property, vl: string, c: IHighLevelNode): boolean

- Defined in src/raml1/ast.core/linter.ts:1540
Parameters
- pr: Property
- vl: string
- c: IHighLevelNode
Returns boolean

isValidValueType

isValidValueType(t: ITypeDefinition, h: IHighLevelNode, v: any, p: IProperty, attr?: IAttribute): any

- Defined in src/raml1/ast.core/linter.ts:1061
Parameters
- t: ITypeDefinition
- h: IHighLevelNode
- v: any
- p: IProperty
- Optional attr: IAttribute
Returns any

isXML

isXML(s: string): boolean

- Defined in src/raml1/ast.core/linter.ts:3367
Parameters
- s: string
Returns boolean

lintNode

lintNode(astNode: IHighLevelNode, acceptor: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:101
Parameters
- astNode: IHighLevelNode
- acceptor: ValidationAcceptor
Returns void

lintWithFile

lintWithFile(customLinter: string, acceptor: ValidationAcceptor, astNode: IHighLevelNode): void

- Defined in src/raml1/ast.core/linter.ts:76
Parameters
- customLinter: string
- acceptor: ValidationAcceptor
- astNode: IHighLevelNode
Returns void

localError

localError(node: IParseResult, c: any, w: any, message: any, p: boolean, prop: IProperty, positionsSource?: ILowLevelASTNode): object

- Defined in src/raml1/ast.core/linter.ts:3407
Parameters
- node: IParseResult
- c: any
- w: any
- message: any
- p: boolean
- prop: IProperty
- Optional positionsSource: ILowLevelASTNode
Returns object
- code: any
- end: number
- extras: Array<undefined>
- isWarning: any
- message: any
- node: IParseResult
- path: string
- start: number
- unit: ICompilationUnit

localLowLevelError

localLowLevelError(node: ILowLevelASTNode, highLevelAnchor: IParseResult, issueCode: any, isWarning: any, message: any, path: boolean): ValidationIssue

- Defined in src/raml1/ast.core/linter.ts:3465
Parameters
- node: ILowLevelASTNode
- highLevelAnchor: IParseResult
- issueCode: any
- isWarning: any
- message: any
- path: boolean
Returns ValidationIssue

mapPath

mapPath(node: IHighLevelNode, e: IStatus): IParseResult

- Defined in src/raml1/ast.core/linter.ts:2139
Parameters
- node: IHighLevelNode
- e: IStatus
Returns IParseResult

nameForNonReference

nameForNonReference(astNode: IAttribute): any

- Defined in src/raml1/ast.core/linter.ts:1769
Parameters
- astNode: IAttribute
Returns any

restrictUnknownNodeError

restrictUnknownNodeError(node: BasicASTNode): any

- Defined in src/raml1/ast.core/linter.ts:272
Parameters
- node: BasicASTNode
Returns any

specializeReferenceError

specializeReferenceError(originalMessage: string, property: Property, astNode: IAttribute): string

- Defined in src/raml1/ast.core/linter.ts:1753
Sometimes we need a more specialized message for the bad references, which diviate from a general algorithm. Like listing possible values etc. This method is responsible for such cases.

Parameters
- originalMessage: string
- property: Property
- astNode: IAttribute
Returns string

toIssue

toIssue(error: any, node: IHighLevelNode): ValidationIssue

- Defined in src/raml1/ast.core/linter.ts:3502
Parameters
- error: any
- node: IHighLevelNode
Returns ValidationIssue

toReadableName

toReadableName(template: string, toLowerCase?: boolean, pluralize_?: boolean): any

- Defined in src/raml1/ast.core/linter.ts:3135
Parameters
- template: string
- Optional toLowerCase: boolean
- Optional pluralize_: boolean
Returns any

typeOfContainingTemplate

typeOfContainingTemplate(h: IHighLevelNode): string

- Defined in src/raml1/ast.core/linter.ts:254
For descendants of templates returns template type. Returns null for all other nodes.

Parameters
- h: IHighLevelNode
Returns string

validate

validate(node: IParseResult, v: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:507
Parameters
- node: IParseResult
- v: ValidationAcceptor
Returns void

validateBasic

validateBasic(node: BasicASTNode, v: ValidationAcceptor, requiredOnly?: boolean): void

- Defined in src/raml1/ast.core/linter.ts:343
Parameters
- node: BasicASTNode
- v: ValidationAcceptor
- Default value requiredOnly: boolean = false
Returns void

validateIncludes

validateIncludes(node: IParseResult, v: ValidationAcceptor): void

- Defined in src/raml1/ast.core/linter.ts:673
Parameters
- node: IParseResult
- v: ValidationAcceptor
Returns void

validateIncludesLL

validateIncludesLL(llNode: ILowLevelASTNode, v: ValidationAcceptor, node: IParseResult): void

- Defined in src/raml1/ast.core/linter.ts:716
Parameters
- llNode: ILowLevelASTNode
- v: ValidationAcceptor
- node: IParseResult
Returns void

validateRegexp

validateRegexp(cleanedValue: string, v: ValidationAcceptor, node: IParseResult): void

- Defined in src/raml1/ast.core/linter.ts:772
Parameters
- cleanedValue: string
- v: ValidationAcceptor
- node: IParseResult
Returns void

validateResponseString

validateResponseString(v: string): any

- Defined in src/raml1/ast.core/linter.ts:3586
Parameters
- v: string
Returns any

Object literals

RESERVED_TEMPLATE_PARAMETERS

RESERVED_TEMPLATE_PARAMETERS: object

methodName

methodName: string

resourcePath

resourcePath: string

resourcePathName

resourcePathName: string

allowOverride

allowOverride: object

body

body: number

headers

headers: number

methods

methods: number

queryParameters

queryParameters: number

resources

resources: number

responses

responses: number

Generated using TypeDoc