mongodb-rag-core/build/contentStore/PageFormat.d.ts

Common elements used by MongoDB Chatbot Framework components.

/**
  The list of canonical file formats that we support for pages.
 */
export declare const pageFormats: ("txt" | "md" | "mdx" | "restructuredtext" | "csv" | "json" | "yaml" | "toml" | "xml" | "openapi-yaml" | "openapi-json" | "graphql" | "c" | "cpp" | "csharp" | "go" | "html" | "java" | "javascript" | "kotlin" | "latex" | "objective-c" | "php" | "python" | "ruby" | "rust" | "scala" | "shell" | "swift" | "typescript")[];
/**
  Maps a string to the canonical page format it represents.

  @returns The canonical page format, or undefined if the string is not
  a recognized page format.
 */
export declare const asPageFormat: (str: string) => PageFormat | undefined;
/**
  A canonical page format.
 */
export type PageFormat = (typeof pageFormats)[number];
/**
  Type guard to check if a string is a canonical page format.
 */
export declare function isPageFormat(str: string): str is PageFormat;
/**
  Converts a string to a canonical page format. If the string is not a
  recognized page format or a synonym for one, this returns a default
  page format.
 */
export declare function pageFormat(str: string, defaultPageFormat?: PageFormat): PageFormat;
//# sourceMappingURL=PageFormat.d.ts.map