@prismicio/client
Version:
The official JavaScript + TypeScript client library for Prismic
32 lines (31 loc) • 1.24 kB
text/typescript
import { PrismicDocument } from "./types/value/document.cjs";
import { WriteClient } from "./WriteClient.cjs";
//#region src/createWriteClient.d.ts
/**
* Type definitions for the `createWriteClient()` function. May be augmented by third-party
* libraries.
*/
interface CreateWriteClient {
<TDocuments extends PrismicDocument>(...args: ConstructorParameters<typeof WriteClient>): WriteClient<TDocuments>;
}
/**
* Creates a Prismic client that can be used to query and write content to a repository.
*
* @remarks
* This client works in environments supporting File, Blob, and FormData, including Node.js 20 and
* later.
* @example
* ;```ts
* createWriteClient("qwerty", { writeToken: "***" })
* ```
*
* @typeParam TDocuments - A union of Prismic document types for the repository.
* @param repositoryName - The Prismic repository name for the repository.
* @param options - Configuration that determines how content will be queried from and written to
* the Prismic repository.
* @returns A client that can query and write content to the repository.
*/
declare const createWriteClient: CreateWriteClient;
//#endregion
export { CreateWriteClient, createWriteClient };
//# sourceMappingURL=createWriteClient.d.cts.map