Class SanityClient

Index

Constructors

Properties

assets datasets listen live observable projects users

Methods

action clone config create createIfNotExists createOrReplace dataRequest delete fetch getDataUrl getDocument getDocuments getUrl mutate patch request transaction withConfig

Constructors

constructor

new SanityClient(httpRequest: HttpRequest, config?: ClientConfig): SanityClient
Parameters
- httpRequest: HttpRequest
- config: ClientConfig = defaultConfig
Returns SanityClient
- Defined in src/SanityClient.ts:753

Properties

assets

assets: AssetsClient

datasets

datasets: DatasetsClient

listen

listen: {
    <R extends Record<string, any> = Record<string, any>>(
        this: ObservableSanityClient | SanityClient,
        query: string,
        params?: ListenParams,
    ): Observable<MutationEvent<R>>;
    <R extends Record<string, any> = Record<string, any>>(
        this: ObservableSanityClient | SanityClient,
        query: string,
        params?: ListenParams,
        options?: ListenOptions,
    ): Observable<ListenEvent<R>>;
} = _listen

Instance properties

Type declaration

- <R extends Record<string, any> = Record<string, any>>(
      this: ObservableSanityClient | SanityClient,
      query: string,
      params?: ListenParams,
  ): Observable<MutationEvent<R>>
- Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  Type Parameters
  - R extends Record<string, any> = Record<string, any>
  Parameters
  - this: ObservableSanityClient | SanityClient
  - query: string
    GROQ-filter to listen to changes for
  - Optionalparams: ListenParams
    Optional query parameters
  Returns Observable<MutationEvent<R>>
- <R extends Record<string, any> = Record<string, any>>(
      this: ObservableSanityClient | SanityClient,
      query: string,
      params?: ListenParams,
      options?: ListenOptions,
  ): Observable<ListenEvent<R>>
- Set up a listener that will be notified when mutations occur on documents matching the provided query/filter.
  Type Parameters
  - R extends Record<string, any> = Record<string, any>
  Parameters
  - this: ObservableSanityClient | SanityClient
  - query: string
    GROQ-filter to listen to changes for
  - Optionalparams: ListenParams
    Optional query parameters
  - Optionaloptions: ListenOptions
    Optional listener options
  Returns Observable<ListenEvent<R>>

live

live: LiveClient

observable

observable: ObservableSanityClient

Observable version of the Sanity client, with the same configuration as the promise-based one

projects

projects: ProjectsClient

users

users: UsersClient

Methods

action

action(
operations: Action | Action[],
options?: BaseActionOptions,
): Promise<SingleActionResult | MultipleActionResult>
Perform action operations against the configured dataset Returns a promise that resolves to the transaction result
Parameters
- operations: Action | Action[]
  Action operation(s) to execute
- Optionaloptions: BaseActionOptions
  Action options
Returns Promise<SingleActionResult | MultipleActionResult>
- Defined in src/SanityClient.ts:1380

clone

clone(): SanityClient
Clone the client - returns a new instance

Returns SanityClient
- Defined in src/SanityClient.ts:770

config

config(): InitializedClientConfig
Returns the current client configuration

Returns InitializedClientConfig
- Defined in src/SanityClient.ts:777
config(newConfig?: Partial<ClientConfig>): this
Reconfigure the client. Note that this mutates the current client.
Parameters
- OptionalnewConfig: Partial<ClientConfig>
Returns this
- Defined in src/SanityClient.ts:781

create

create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: SanityDocumentStub<R>
  Document to create
- options: FirstDocumentMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:931
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns a promise that resolves to an array containing the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: SanityDocumentStub<R>
  Document to create
- options: AllDocumentsMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:942
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns a promise that resolves to a mutation result object containing the ID of the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: SanityDocumentStub<R>
  Document to create
- options: FirstDocumentIdMutationOptions
  Mutation options
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:953
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns a promise that resolves to a mutation result object containing the ID of the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: SanityDocumentStub<R>
  Document to create
- options: AllDocumentIdsMutationOptions
  Mutation options
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:964
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: SanityDocumentStub<R>
  Document to create
- Optionaloptions: BaseMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:975

createIfNotExists

createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Create a document if no document with the same ID already exists. Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to create
- options: FirstDocumentMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1002
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Create a document if no document with the same ID already exists. Returns a promise that resolves to an array containing the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to create
- options: AllDocumentsMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:1013
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Create a document if no document with the same ID already exists. Returns a promise that resolves to a mutation result object containing the ID of the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to create
- options: FirstDocumentIdMutationOptions
  Mutation options
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:1024
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Create a document if no document with the same ID already exists. Returns a promise that resolves to a mutation result object containing the ID of the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to create
- options: AllDocumentIdsMutationOptions
  Mutation options
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:1035
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Create a document if no document with the same ID already exists. Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to create
- Optionaloptions: BaseMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1046

createOrReplace

createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Create a document if it does not exist, or replace a document with the same document ID Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to either create or replace
- options: FirstDocumentMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1073
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Create a document if it does not exist, or replace a document with the same document ID Returns a promise that resolves to an array containing the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to either create or replace
- options: AllDocumentsMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:1084
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Create a document if it does not exist, or replace a document with the same document ID Returns a promise that resolves to a mutation result object containing the ID of the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to either create or replace
- options: FirstDocumentIdMutationOptions
  Mutation options
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:1095
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Create a document if it does not exist, or replace a document with the same document ID Returns a promise that resolves to a mutation result object containing the created document ID.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to either create or replace
- options: AllDocumentIdsMutationOptions
  Mutation options
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:1106
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Create a document if it does not exist, or replace a document with the same document ID Returns a promise that resolves to the created document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- document: IdentifiedSanityDocumentStub<R>
  Document to either create or replace
- Optionaloptions: BaseMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1117

dataRequest

dataRequest(
    endpoint: string,
    body: unknown,
    options?: BaseMutationOptions,
): Promise<any>
Internal
Perform an HTTP request a /data sub-endpoint NOTE: Considered internal, thus marked as deprecated. Use request instead.
Parameters
- endpoint: string
  Endpoint to hit (mutate, query etc)
- body: unknown
  Request body
- Optionaloptions: BaseMutationOptions
  Request options
Returns Promise<any>
Deprecated
- Use request() or your own HTTP library instead
- Defined in src/SanityClient.ts:1408

delete

delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Deletes a document with the given document ID. Returns a promise that resolves to the deleted document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- id: string
  Document ID to delete
- options: FirstDocumentMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1144
delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Deletes a document with the given document ID. Returns a promise that resolves to an array containing the deleted document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- id: string
  Document ID to delete
- options: AllDocumentsMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:1155
delete(
id: string,
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Deletes a document with the given document ID. Returns a promise that resolves to a mutation result object containing the deleted document ID.
Parameters
- id: string
  Document ID to delete
- options: FirstDocumentIdMutationOptions
  Options for the mutation
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:1166
delete(
id: string,
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Deletes a document with the given document ID. Returns a promise that resolves to a mutation result object containing the deleted document ID.
Parameters
- id: string
  Document ID to delete
- options: AllDocumentIdsMutationOptions
  Options for the mutation
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:1174
delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Deletes a document with the given document ID. Returns a promise that resolves to the deleted document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- id: string
  Document ID to delete
- Optionaloptions: BaseMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1182
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Deletes one or more documents matching the given query or document ID. Returns a promise that resolves to first deleted document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- selection: MutationSelection
  An object with either an id or query key defining what to delete
- options: FirstDocumentMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1193
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Deletes one or more documents matching the given query or document ID. Returns a promise that resolves to an array containing the deleted documents.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- selection: MutationSelection
  An object with either an id or query key defining what to delete
- options: AllDocumentsMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:1204
delete(
selection: MutationSelection,
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Deletes one or more documents matching the given query or document ID. Returns a promise that resolves to a mutation result object containing the ID of the first deleted document.
Parameters
- selection: MutationSelection
  An object with either an id or query key defining what to delete
- options: FirstDocumentIdMutationOptions
  Options for the mutation
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:1215
delete(
selection: MutationSelection,
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Deletes one or more documents matching the given query or document ID. Returns a promise that resolves to a mutation result object containing the document IDs that were deleted.
Parameters
- selection: MutationSelection
  An object with either an id or query key defining what to delete
- options: AllDocumentIdsMutationOptions
  Options for the mutation
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:1226
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Deletes one or more documents matching the given query or document ID. Returns a promise that resolves to first deleted document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- selection: MutationSelection
  An object with either an id or query key defining what to delete
- Optionaloptions: BaseMutationOptions
  Options for the mutation
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1237

fetch

fetch<
    R = any,
    Q extends QueryWithoutParams = QueryWithoutParams,
    const G extends string = string,
>(
    query: G,
    params?: QueryWithoutParams | Q,
): Promise<ClientReturn<G, R>>
Perform a GROQ-query against the configured dataset.
Type Parameters
- R = any
- Q extends QueryWithoutParams = QueryWithoutParams
- const G extends string = string
Parameters
- query: G
  GROQ-query to perform
- Optionalparams: QueryWithoutParams | Q
Returns Promise<ClientReturn<G, R>>
- Defined in src/SanityClient.ts:825
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: G,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options?: FilteredResponseQueryOptions,
): Promise<ClientReturn<G, R>>
Perform a GROQ-query against the configured dataset.
Type Parameters
- R = any
- Q extends QueryParams | QueryWithoutParams = QueryParams
- const G extends string = string
Parameters
- query: G
  GROQ-query to perform
- params: Q extends QueryWithoutParams ? QueryWithoutParams : Q
  Optional query parameters
- Optionaloptions: FilteredResponseQueryOptions
  Optional request options
Returns Promise<ClientReturn<G, R>>
- Defined in src/SanityClient.ts:837
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: G,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options: UnfilteredResponseQueryOptions,
): Promise<RawQueryResponse<ClientReturn<G, R>>>
Perform a GROQ-query against the configured dataset.
Type Parameters
- R = any
- Q extends QueryParams | QueryWithoutParams = QueryParams
- const G extends string = string
Parameters
- query: G
  GROQ-query to perform
- params: Q extends QueryWithoutParams ? QueryWithoutParams : Q
  Optional query parameters
- options: UnfilteredResponseQueryOptions
  Request options
Returns Promise<RawQueryResponse<ClientReturn<G, R>>>
- Defined in src/SanityClient.ts:853
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: G,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options: UnfilteredResponseWithoutQuery,
): Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
Perform a GROQ-query against the configured dataset.
Type Parameters
- R = any
- Q extends QueryParams | QueryWithoutParams = QueryParams
- const G extends string = string
Parameters
- query: G
  GROQ-query to perform
- params: Q extends QueryWithoutParams ? QueryWithoutParams : Q
  Optional query parameters
- options: UnfilteredResponseWithoutQuery
  Request options
Returns Promise<RawQuerylessQueryResponse<ClientReturn<G, R>>>
- Defined in src/SanityClient.ts:869

getDataUrl

getDataUrl(operation: string, path?: string): string
Get a Sanity API URL for the data operation and path provided
Parameters
- operation: string
  Data operation (eg query, mutate, listen or similar)
- Optionalpath: string
  Path to append after the operation
Returns string
- Defined in src/SanityClient.ts:1428

getDocument

getDocument<R extends Record<string, any> = Record<string, any>>(
id: string,
options?: { signal?: AbortSignal; tag?: string },
): Promise<undefined | SanityDocument<R>>
Fetch a single document with the given ID.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- id: string
  Document ID to fetch
- Optionaloptions: { signal?: AbortSignal; tag?: string }
  Request options
Returns Promise<undefined | SanityDocument<R>>
- Defined in src/SanityClient.ts:901

getDocuments

getDocuments<R extends Record<string, any> = Record<string, any>>(
ids: string[],
options?: { signal?: AbortSignal; tag?: string },
): Promise<(null | SanityDocument<R>)[]>
Fetch multiple documents in one request. Should be used sparingly - performing a query is usually a better option. The order/position of documents is preserved based on the original array of IDs. If any of the documents are missing, they will be replaced by a null entry in the returned array
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- ids: string[]
  Document IDs to fetch
- Optionaloptions: { signal?: AbortSignal; tag?: string }
  Request options
Returns Promise<(null | SanityDocument<R>)[]>
- Defined in src/SanityClient.ts:917

getUrl

getUrl(uri: string, canUseCdn?: boolean): string
Get a Sanity API URL for the URI provided
Parameters
- uri: string
  URI/path to build URL for
- OptionalcanUseCdn: boolean
  Whether or not to allow using the API CDN for this route
Returns string
- Defined in src/SanityClient.ts:1418

mutate

mutate<R extends Record<string, any> = Record<string, any>>(
operations: Patch | Mutation<R>[] | Transaction,
options: FirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Perform mutation operations against the configured dataset Returns a promise that resolves to the first mutated document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: Patch | Mutation<R>[] | Transaction
  Mutation operations to execute
- options: FirstDocumentMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1262
mutate<R extends Record<string, any> = Record<string, any>>(
operations: Patch | Transaction | Mutation<R>[],
options: AllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Perform mutation operations against the configured dataset. Returns a promise that resolves to an array of the mutated documents.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: Patch | Transaction | Mutation<R>[]
  Mutation operations to execute
- options: AllDocumentsMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:1273
mutate<R extends Record<string, any> = Record<string, any>>(
operations: Patch | Transaction | Mutation<R>[],
options: FirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Perform mutation operations against the configured dataset Returns a promise that resolves to a mutation result object containing the document ID of the first mutated document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: Patch | Transaction | Mutation<R>[]
  Mutation operations to execute
- options: FirstDocumentIdMutationOptions
  Mutation options
Returns Promise<SingleMutationResult>
- Defined in src/SanityClient.ts:1284
mutate<R extends Record<string, any>>(
operations: Patch | Transaction | Mutation<R>[],
options: AllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Perform mutation operations against the configured dataset Returns a promise that resolves to a mutation result object containing the mutated document IDs.
Type Parameters
- R extends Record<string, any>
Parameters
- operations: Patch | Transaction | Mutation<R>[]
  Mutation operations to execute
- options: AllDocumentIdsMutationOptions
  Mutation options
Returns Promise<MultipleMutationResult>
- Defined in src/SanityClient.ts:1295
mutate<R extends Record<string, any> = Record<string, any>>(
operations: Patch | Transaction | Mutation<R>[],
options?: BaseMutationOptions,
): Promise<SanityDocument<R>>
Perform mutation operations against the configured dataset Returns a promise that resolves to the first mutated document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: Patch | Transaction | Mutation<R>[]
  Mutation operations to execute
- Optionaloptions: BaseMutationOptions
  Mutation options
Returns Promise<SanityDocument<R>>
- Defined in src/SanityClient.ts:1306

patch

patch(documentId: string, operations?: PatchOperations): Patch
Create a new buildable patch of operations to perform
Parameters
- documentId: string
  Document ID to patch
- Optionaloperations: PatchOperations
  Optional object of patch operations to initialize the patch instance with
Returns Patch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:1331
patch(documentIds: string[], operations?: PatchOperations): Patch
Create a new buildable patch of operations to perform
Parameters
- documentIds: string[]
  Array of document IDs to patch
- Optionaloperations: PatchOperations
  Optional object of patch operations to initialize the patch instance with
Returns Patch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:1340
patch(selection: MutationSelection, operations?: PatchOperations): Patch
Create a new buildable patch of operations to perform
Parameters
- selection: MutationSelection
  An object with query and optional params, defining which document(s) to patch
- Optionaloperations: PatchOperations
  Optional object of patch operations to initialize the patch instance with
Returns Patch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:1349

request

request<R = any>(options: RawRequestOptions): Promise<R>
Perform a request against the Sanity API NOTE: Only use this for Sanity API endpoints, not for your own APIs!
Type Parameters
- R = any
Parameters
- options: RawRequestOptions
  Request options
Returns Promise<R>
Promise resolving to the response body
- Defined in src/SanityClient.ts:1394

transaction

transaction<R extends Record<string, any> = Record<string, any>>(
operations?: Mutation<R>[],
): Transaction
Create a new transaction of mutations
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- Optionaloperations: Mutation<R>[]
  Optional array of mutation operations to initialize the transaction instance with
Returns Transaction
- Defined in src/SanityClient.ts:1367

withConfig

withConfig(newConfig?: Partial<ClientConfig>): SanityClient
Clone the client with a new (partial) configuration.
Parameters
- OptionalnewConfig: Partial<ClientConfig>
  New client configuration properties, shallowly merged with existing configuration
Returns SanityClient
- Defined in src/SanityClient.ts:806

Class SanityClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SanityClient

Properties

assets

datasets

listen

Type declaration

Type Parameters

Parameters

Returns Observable<MutationEvent<R>>

Type Parameters

Parameters

Returns Observable<ListenEvent<R>>

live

observable

projects

users

Methods

action

Parameters

Returns Promise<SingleActionResult | MultipleActionResult>

clone

Returns SanityClient

config

Returns InitializedClientConfig

Parameters

Returns this

create

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Promise<SingleMutationResult>

Type Parameters

Parameters

Returns Promise<MultipleMutationResult>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

createIfNotExists

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Promise<SingleMutationResult>

Type Parameters

Parameters

Returns Promise<MultipleMutationResult>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

createOrReplace

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Promise<SingleMutationResult>

Type Parameters

Parameters

Returns Promise<MultipleMutationResult>

Type Parameters