Interface DjockeyPlugin

interface DjockeyPlugin {
    doAsyncWorkBetweenReadAndWrite?: ((args: {
        doc: DjockeyDoc;
        logCollector: LogCollector;
    }) => Promise<void>);
    getNodeReservations?: ((config: DjockeyConfigResolved) => DjockeyPluginNodeReservation[]);
    getShouldIncludeStaticFileInDoc?: ((args: {
        doc: DjockeyDoc;
        staticFileRefPath: string;
    }) => boolean);
    getStaticFiles?: ((args: {
        config: DjockeyConfigResolved;
        docs: DjockeyDoc[];
        logCollector: LogCollector;
        renderer: DjockeyRenderer;
    }) => DjockeyStaticFileFromPlugin[]);
    name: string;
    onPass_read?: ((args: {
        doc: DjockeyDoc;
        getIsNodeReservedByAnotherPlugin: ((node: AstNode) => boolean);
        logCollector: LogCollector;
    }) => void);
    onPass_write?: ((args: {
        doc: DjockeyDoc;
        getIsNodeReservedByAnotherPlugin: ((node: AstNode) => boolean);
        logCollector: LogCollector;
    }) => void);
    onPrepareForRender?: ((args: {
        config: DjockeyConfigResolved;
        doc: DjockeyDoc;
        logCollector: LogCollector;
        renderer: DjockeyRenderer;
    }) => void);
    setup?: ((args: {
        logCollector: LogCollector;
    }) => Promise<void>);
}

Properties

doAsyncWorkBetweenReadAndWrite? getNodeReservations? getShouldIncludeStaticFileInDoc? getStaticFiles? name onPass_read? onPass_write? onPrepareForRender? setup?

Properties

OptionaldoAsyncWorkBetweenReadAndWrite

doAsyncWorkBetweenReadAndWrite?: ((args: {
    doc: DjockeyDoc;
    logCollector: LogCollector;
}) => Promise<void>)

OptionalgetNodeReservations

getNodeReservations?: ((config: DjockeyConfigResolved) => DjockeyPluginNodeReservation[])

OptionalgetShouldIncludeStaticFileInDoc

getShouldIncludeStaticFileInDoc?: ((args: {
    doc: DjockeyDoc;
    staticFileRefPath: string;
}) => boolean)

OptionalgetStaticFiles

getStaticFiles?: ((args: {
    config: DjockeyConfigResolved;
    docs: DjockeyDoc[];
    logCollector: LogCollector;
    renderer: DjockeyRenderer;
}) => DjockeyStaticFileFromPlugin[])

name

name: string

OptionalonPass_read

onPass_read?: ((args: {
    doc: DjockeyDoc;
    getIsNodeReservedByAnotherPlugin: ((node: AstNode) => boolean);
    logCollector: LogCollector;
}) => void)

OptionalonPass_write

onPass_write?: ((args: {
    doc: DjockeyDoc;
    getIsNodeReservedByAnotherPlugin: ((node: AstNode) => boolean);
    logCollector: LogCollector;
}) => void)

OptionalonPrepareForRender

onPrepareForRender?: ((args: {
    config: DjockeyConfigResolved;
    doc: DjockeyDoc;
    logCollector: LogCollector;
    renderer: DjockeyRenderer;
}) => void)

Optionalsetup

setup?: ((args: {
    logCollector: LogCollector;
}) => Promise<void>)

Settings

Member Visibility

On This Page

Properties