@prismicio/client/dist/createClient.d.cts

The official JavaScript + TypeScript client library for Prismic

import { PrismicDocument } from "./types/value/document.cjs";
import { Client } from "./Client.cjs";

//#region src/createClient.d.ts

/**
 * Type definitions for the `createClient()` function. May be augmented by
 * third-party libraries.
 */
interface CreateClient {
  <TDocuments extends PrismicDocument>(...args: ConstructorParameters<typeof Client>): Client<TDocuments>;
}
/**
 * Creates a Prismic client that can be used to query content from a repository.
 *
 * @example
 *
 * ```ts
 * // With a repository name
 * createClient("my-repo")
 *
 * // With a full Prismic Content API endpoint
 * createClient("https://my-repo.cdn.prismic.io/api/v2")
 * ```
 *
 * @typeParam TDocuments - A union of Prismic page and custom types for the
 *   repository.
 *
 * @param repositoryNameOrEndpoint - The Prismic repository name or full Content
 *   API endpoint for the repository.
 * @param options - Configuration that determines how content will be queried
 *   from the Prismic repository.
 *
 * @returns A client that can query content from the repository.
 *
 * @see https://prismic.io/docs/technical-reference/prismicio-client/v7
 */
declare const createClient: CreateClient;
//#endregion
export { CreateClient, createClient };
//# sourceMappingURL=createClient.d.cts.map