Interface SyntaxMode

interface SyntaxMode {
    HighlightRules: (new (config?) => HighlightRules);
    blockComment?: {
        end: string;
        start: string;
    };
    completionKeywords: string[];
    foldingRules?: FoldMode;
    lineCommentStart?: string;
    nonTokenRe?: RegExp;
    path?: string;
    tokenRe?: RegExp;
    transformAction: BehaviorAction;
    autoOutdent(state, doc, row): void;
    checkOutdent(state, line, input): boolean;
    createModeDelegates(mapping): void;
    createWorker(session): any;
    getCompletions(state, session, pos, prefix): Completion[];
    getKeywords(append?): (string | RegExp)[];
    getNextLineIndent(state, line, tab): string;
    getTokenizer(): Tokenizer;
    toggleBlockComment(state, session, range, cursor): void;
    toggleCommentLines(state, session, startRow, endRow): void;
}

Properties

HighlightRules blockComment? completionKeywords foldingRules? lineCommentStart? nonTokenRe? path? tokenRe? transformAction

Methods

autoOutdent checkOutdent createModeDelegates createWorker getCompletions getKeywords getNextLineIndent getTokenizer toggleBlockComment toggleCommentLines

Properties

HighlightRules

HighlightRules: (new (config?) => HighlightRules)

Type declaration

Optional blockComment

blockComment?: {
    end: string;
    start: string;
}

characters that indicate the start and end of a block comment

Type declaration

  • end: string
  • start: string

completionKeywords

completionKeywords: string[]

Optional foldingRules

foldingRules?: FoldMode

Optional lineCommentStart

lineCommentStart?: string

characters that indicate the start of a line comment

Optional nonTokenRe

nonTokenRe?: RegExp

Optional path

path?: string

Optional tokenRe

tokenRe?: RegExp

transformAction

transformAction: BehaviorAction

Methods

autoOutdent

  • autoOutdent(state, doc, row): void

  • Parameters

    Returns void

checkOutdent

  • checkOutdent(state, line, input): boolean

  • Parameters

    • state: string | string[]
    • line: string
    • input: string

    Returns boolean

createModeDelegates

  • createModeDelegates(mapping): void

  • Parameters

    • mapping: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns void

createWorker

getCompletions

  • getCompletions(state, session, pos, prefix): Completion[]

  • Parameters

    Returns Completion[]

getKeywords

  • getKeywords(append?): (string | RegExp)[]

  • Parameters

    • Optional append: boolean

    Returns (string | RegExp)[]

getNextLineIndent

  • getNextLineIndent(state, line, tab): string

  • Parameters

    • state: string | string[]
    • line: string
    • tab: string

    Returns string

getTokenizer

  • getTokenizer(): Tokenizer

  • Returns Tokenizer

toggleBlockComment

toggleCommentLines

  • toggleCommentLines(state, session, startRow, endRow): void

  • Parameters

    • state: string | string[]
    • session: EditSession
    • startRow: number
    • endRow: number

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc