@mintlify/common/dist/getFileCategory.d.ts

Commonly shared code within Mintlify

export type FileCategoryOptions = {
    importedFiles?: Set<string>;
};
export type PotentialFileCategory = 'page' | 'snippet' | 'mintConfig' | 'potentialYamlOpenApiSpec' | 'potentialJsonOpenApiSpec' | 'staticFile' | 'snippet-v2' | 'css' | 'js' | 'docsConfig' | 'generatedStaticFile' | 'skillFile' | 'mintIgnore' | null;
export type FileCategory = Omit<PotentialFileCategory, 'potentialYamlOpenApiSpec' | 'potentialJsonOpenApiSpec'> | 'openApi' | null;
export declare const generatedStaticFiles: readonly ["llms.txt", "robots.txt", "sitemap.xml", "llms-full.txt"];
export type GeneratedStaticFile = (typeof generatedStaticFiles)[number];
export declare const IMAGE_FORMATS: string[];
export declare const VIDEO_FORMATS: string[];
export declare const AUDIO_FORMATS: string[];
export declare const DOCUMENT_FORMATS: string[];
export declare const DATA_FORMATS: string[];
export declare const FONT_FORMATS: string[];
export declare const COMPRESSED_FORMATS: string[];
export declare function isGatedFormat(params: {
    filePath: string;
    ext?: undefined;
}): boolean;
export declare function isGatedFormat(params: {
    filePath?: undefined;
    ext: string;
}): boolean;
export declare const getFileCategory: (filePath: string, options?: FileCategoryOptions) => PotentialFileCategory;