Ace API Reference
    Preparing search index...

    Interface SyntaxMode

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

    Properties

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

    Methods

    autoOutdent checkOutdent createModeDelegates createWorker getCompletions getKeywords getNextLineIndent getTokenizer toggleBlockComment toggleCommentLines

    Properties

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

    characters that indicate the start and end of a block comment

    completionKeywords: string[]
    foldingRules?: FoldMode
    HighlightRules: new (config?: any) => HighlightRules
    lineCommentStart?: string

    characters that indicate the start of a line comment

    nonTokenRe?: RegExp
    path?: string
    tokenRe?: RegExp
    transformAction: BehaviorAction

    Methods

    • Parameters

      Returns void

    • Parameters

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

      Returns boolean

    • Parameters

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

      Returns void

    • Parameters

      Returns Completion[]

    • Parameters

      • Optionalappend: boolean

      Returns (string | RegExp)[]

    • Parameters

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

      Returns string

    • Returns Tokenizer

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods