staticql
Version:
Type-safe query engine for static content including Markdown, YAML, JSON, and more.
21 lines (20 loc) • 1.01 kB
TypeScript
import { StaticQL, StaticQLConfig, StaticQLInitOptions } from "./StaticQL.js";
import { StorageRepository } from "./repository/StorageRepository.js";
/**
* Factory function to create a StaticQL instance.
*
* @param config - The StaticQL configuration object.
* @returns A factory function that accepts a repository and optional init options.
*/
export declare function defineStaticQL(config: StaticQLConfig): ({ repository, defaultRepository, sourceRepositories, writeRepository, options, }: {
repository?: StorageRepository;
defaultRepository?: StorageRepository;
sourceRepositories?: Record<string, StorageRepository>;
writeRepository?: StorageRepository;
options?: StaticQLInitOptions;
}) => StaticQL;
export type { StaticQL, StaticQLConfig } from "./StaticQL.js";
export type { Validator } from "./validator/Validator.js";
export { ConsoleLogger } from "./logger/ConsoleLogger.js";
export type { PageInfo } from "./utils/pagenation.js";
export type { DiffEntry } from "./Indexer.js";