@nuxtjs/sanity
Version:
Sanity integration for Nuxt
60 lines (59 loc) • 2.18 kB
TypeScript
export type QueryParams = Record<string, unknown>;
export interface QueryOptions {
perspective?: ClientConfig['perspective'];
filterResponse?: boolean;
}
export type ContentSourceMap = unknown;
export interface ClientConfig {
useCdn?: boolean;
projectId: string;
dataset?: string;
apiVersion: string;
withCredentials?: boolean;
token?: string;
perspective?: 'raw' | 'published' | 'previewDrafts';
}
/** @deprecated Prefer `ClientConfig` instead - this will be removed in a future version. */
export interface SanityConfiguration extends ClientConfig {
}
export declare function getQuery(query: string, params?: Record<string, unknown>): string;
export declare const getByteSize: (query: string) => number;
export declare function createClient(config: ClientConfig): {
config: () => {
useCdn: boolean | undefined;
projectId: string;
dataset: string | undefined;
apiVersion: string;
withCredentials: boolean | undefined;
token: string | undefined;
perspective: "raw" | "published" | "previewDrafts";
};
clone: () => {
config: () => {
useCdn: boolean | undefined;
projectId: string;
dataset: string | undefined;
apiVersion: string;
withCredentials: boolean | undefined;
token: string | undefined;
perspective: "raw" | "published" | "previewDrafts";
};
clone: /*elided*/ any;
fetch: {
<T = unknown>(query: string, params: Record<string, unknown> | undefined, options: QueryOptions & {
filterResponse: false;
}): Promise<{
result: T;
}>;
<T = unknown>(query: string, params?: Record<string, unknown>, options?: QueryOptions): Promise<T>;
};
};
fetch: {
<T = unknown>(query: string, params: Record<string, unknown> | undefined, options: QueryOptions & {
filterResponse: false;
}): Promise<{
result: T;
}>;
<T = unknown>(query: string, params?: Record<string, unknown>, options?: QueryOptions): Promise<T>;
};
};