uniorg-parse/lib/parse-options.d.ts

uniorg plugin to parse org-mode

export interface ParseOptions {
    /**
     * Similar to `org-todo-keywords` in Emacs, but it only accepts a
     * plain list of keywords.
     */
    todoKeywords: string[];
    /**
     * Same as `org-use-sub-superscripts` in Emacs.
     *
     * - `true` (default) - parse sub-/superscripts
     * - `false` - do not parse sub-/superscripts
     * - `'{}'` - only parse sub-/superscripts when enclosed in braces
     */
    useSubSuperscripts: true | false | '{}';
    /**
     * Allows overriding parameters for emphasis regex. Corresponds to
     * `org-emphasis-regex-components` in Emacs.
     */
    emphasisRegexpComponents: {
        pre: string;
        post: string;
        border: string;
        body: string;
        newline: number;
    };
    /**
     * A list of allowed URI schemes that are recognized as URLs. You
     * can get this list in emacs by calling `(org-link-types)`.
     */
    linkTypes: string[];
    /**
     * Number of stacked braces for sub/superscript
     * matching. Corresponds to `org-match-sexp-depth` in Emacs.
     */
    matchSexpDepth: number;
    /**
     * Track position information for each node according to the unist spec.
     * When enabled, each node will have a `position` field with `start` and `end` points.
     * This can add some processing overhead, so it's disabled by default.
     *
     * @default false
     */
    trackPosition: boolean;
}
export declare const defaultOptions: ParseOptions;