myst-cli/dist/transforms/outputs.d.ts

Command line tools for MyST

import type { SourceFileKind } from 'myst-spec-ext';
import type { GenericParent } from 'myst-common';
import type { ProjectSettings } from 'myst-frontmatter';
import type { VFile } from 'vfile';
import type { ISession } from '../session/types.js';
/**
 * Traverse all output nodes, minify their content, and cache on the session
 */
export declare function transformOutputsToCache(session: ISession, mdast: GenericParent, kind: SourceFileKind, opts?: {
    minifyMaxCharacters?: number;
}): Promise<void>;
export declare function stringIsMatplotlibOutput(value?: string): boolean;
/** Remove warnings and errors from outputs */
export declare function transformFilterOutputStreams(mdast: GenericParent, vfile: VFile, { output_stdout: stdout, output_stderr: stderr, output_matplotlib_strings: mpl, }?: Pick<ProjectSettings, 'output_stdout' | 'output_stderr' | 'output_matplotlib_strings'>): void;
/**
 * Write cached content from output nodes to file
 */
export declare function transformOutputsToFile(session: ISession, mdast: GenericParent, writeFolder: string, opts?: {
    altOutputFolder?: string;
    vfile?: VFile;
}): void;
/**
 * Convert output nodes with minified content to image or code
 *
 * This writes outputs of type image to file, modifies outputs of type
 * text to a code node, and removes other output types.
 */
export declare function reduceOutputs(session: ISession, mdast: GenericParent, file: string, writeFolder: string, opts?: {
    altOutputFolder?: string;
    vfile?: VFile;
}): void;
//# sourceMappingURL=outputs.d.ts.map