Class ObservableSanityClient

Index

Constructors

Properties

assets datasets listen live projects users

Methods

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

Constructors

constructor

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

Properties

assets

assets: ObservableAssetsClient

datasets

datasets: ObservableDatasetsClient

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>>

Methods

action

action(
operations: Action | Action[],
options?: BaseActionOptions,
): Observable<SingleActionResult | MultipleActionResult>
Perform action operations against the configured dataset
Parameters
- operations: Action | Action[]
  Action operation(s) to execute
- Optionaloptions: BaseActionOptions
  Action options
Returns Observable<SingleActionResult | MultipleActionResult>
- Defined in src/SanityClient.ts:692

clone

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

Returns ObservableSanityClient
- Defined in src/SanityClient.ts:95

config

config(): InitializedClientConfig
Returns the current client configuration

Returns InitializedClientConfig
- Defined in src/SanityClient.ts:102
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:106

create

create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:250
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns an observable 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 Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:261
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns an observable 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 Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:272
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns an observable 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 Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:283
create<R extends Record<string, any> = Record<string, any>>(
document: SanityDocumentStub<R>,
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Create a document. Requires a _type property. If no _id is provided, it will be generated by the database. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:294

createIfNotExists

createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Create a document if no document with the same ID already exists. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:319
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Create a document if no document with the same ID already exists. Returns an observable 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 Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:330
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Create a document if no document with the same ID already exists. Returns an observable 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 Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:341
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Create a document if no document with the same ID already exists. Returns an observable 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 Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:352
createIfNotExists<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Create a document if no document with the same ID already exists. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:363

createOrReplace

createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Create a document if it does not exist, or replace a document with the same document ID Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:388
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Create a document if it does not exist, or replace a document with the same document ID Returns an observable 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 Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:399
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Create a document if it does not exist, or replace a document with the same document ID Returns an observable 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 Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:410
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Create a document if it does not exist, or replace a document with the same document ID Returns an observable 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 Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:421
createOrReplace<R extends Record<string, any> = Record<string, any>>(
document: IdentifiedSanityDocumentStub<R>,
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Create a document if it does not exist, or replace a document with the same document ID Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:432

delete

delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Deletes a document with the given document ID. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:457
delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Deletes a document with the given document ID. Returns an observable 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 Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:468
delete(
id: string,
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Deletes a document with the given document ID. Returns an observable 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 Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:479
delete(
id: string,
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Deletes a document with the given document ID. Returns an observable 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 Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:487
delete<R extends Record<string, any> = Record<string, any>>(
id: string,
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Deletes a document with the given document ID. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:495
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Deletes one or more documents matching the given query or document ID. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:506
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Deletes one or more documents matching the given query or document ID. Returns an observable 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 Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:517
delete(
selection: MutationSelection,
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Deletes one or more documents matching the given query or document ID. Returns an observable 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 Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:528
delete(
selection: MutationSelection,
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Deletes one or more documents matching the given query or document ID. Returns an observable 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 Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:539
delete<R extends Record<string, any> = Record<string, any>>(
selection: MutationSelection,
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Deletes one or more documents matching the given query or document ID. Returns an observable 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 Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:550

fetch

fetch<
    R = any,
    Q extends QueryWithoutParams = QueryWithoutParams,
    const G extends string = string,
>(
    query: G,
    params?: QueryWithoutParams | Q,
): Observable<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 Observable<ClientReturn<G, R>>
- Defined in src/SanityClient.ts:146
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: G,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options?: FilteredResponseQueryOptions,
): Observable<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 Observable<ClientReturn<G, R>>
- Defined in src/SanityClient.ts:158
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: string,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options: UnfilteredResponseQueryOptions,
): Observable<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: string
  GROQ-query to perform
- params: Q extends QueryWithoutParams ? QueryWithoutParams : Q
  Optional query parameters
- options: UnfilteredResponseQueryOptions
  Request options
Returns Observable<RawQueryResponse<ClientReturn<G, R>>>
- Defined in src/SanityClient.ts:174
fetch<
    R = any,
    Q extends QueryParams | QueryWithoutParams = QueryParams,
    const G extends string = string,
>(
    query: G,
    params: Q extends QueryWithoutParams ? QueryWithoutParams : Q,
    options: UnfilteredResponseWithoutQuery,
): Observable<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 Observable<RawQuerylessQueryResponse<ClientReturn<G, R>>>
- Defined in src/SanityClient.ts:190

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:724

getDocument

getDocument<R extends Record<string, any> = Record<string, any>>(
id: string,
options?: { tag?: string },
): Observable<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: { tag?: string }
  Request options
Returns Observable<undefined | SanityDocument<R>>
- Defined in src/SanityClient.ts:220

getDocuments

getDocuments<R extends Record<string, any> = Record<string, any>>(
ids: string[],
options?: { tag?: string },
): Observable<(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: { tag?: string }
  Request options
Returns Observable<(null | SanityDocument<R>)[]>
- Defined in src/SanityClient.ts:236

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:714

mutate

mutate<R extends Record<string, any> = Record<string, any>>(
operations: ObservablePatch | Mutation<R>[] | ObservableTransaction,
options: FirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Perform mutation operations against the configured dataset Returns an observable that resolves to the first mutated document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: ObservablePatch | Mutation<R>[] | ObservableTransaction
  Mutation operations to execute
- options: FirstDocumentMutationOptions
  Mutation options
Returns Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:575
mutate<R extends Record<string, any> = Record<string, any>>(
operations: ObservablePatch | ObservableTransaction | Mutation<R>[],
options: AllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Perform mutation operations against the configured dataset. Returns an observable that resolves to an array of the mutated documents.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: ObservablePatch | ObservableTransaction | Mutation<R>[]
  Mutation operations to execute
- options: AllDocumentsMutationOptions
  Mutation options
Returns Observable<SanityDocument<R>[]>
- Defined in src/SanityClient.ts:586
mutate<R extends Record<string, any> = Record<string, any>>(
operations: ObservablePatch | ObservableTransaction | Mutation<R>[],
options: FirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Perform mutation operations against the configured dataset Returns an observable 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: ObservablePatch | ObservableTransaction | Mutation<R>[]
  Mutation operations to execute
- options: FirstDocumentIdMutationOptions
  Mutation options
Returns Observable<SingleMutationResult>
- Defined in src/SanityClient.ts:597
mutate<R extends Record<string, any> = Record<string, any>>(
operations: ObservablePatch | ObservableTransaction | Mutation<R>[],
options: AllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Perform mutation operations against the configured dataset Returns an observable that resolves to a mutation result object containing the mutated document IDs.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: ObservablePatch | ObservableTransaction | Mutation<R>[]
  Mutation operations to execute
- options: AllDocumentIdsMutationOptions
  Mutation options
Returns Observable<MultipleMutationResult>
- Defined in src/SanityClient.ts:608
mutate<R extends Record<string, any> = Record<string, any>>(
operations: ObservablePatch | ObservableTransaction | Mutation<R>[],
options?: BaseMutationOptions,
): Observable<SanityDocument<R>>
Perform mutation operations against the configured dataset Returns an observable that resolves to the first mutated document.
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- operations: ObservablePatch | ObservableTransaction | Mutation<R>[]
  Mutation operations to execute
- Optionaloptions: BaseMutationOptions
  Mutation options
Returns Observable<SanityDocument<R>>
- Defined in src/SanityClient.ts:619

patch

patch(documentId: string, operations?: PatchOperations): ObservablePatch
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 ObservablePatch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:644
patch(documentIds: string[], operations?: PatchOperations): ObservablePatch
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 ObservablePatch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:653
patch(
selection: MutationSelection,
operations?: PatchOperations,
): ObservablePatch
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 ObservablePatch
Patch instance - call .commit() to perform the operations defined
- Defined in src/SanityClient.ts:662

request

request<R = any>(options: RawRequestOptions): Observable<R>
Perform an HTTP request against the Sanity API
Type Parameters
- R = any
Parameters
- options: RawRequestOptions
  Request options
Returns Observable<R>
- Defined in src/SanityClient.ts:704

transaction

transaction<R extends Record<string, any> = Record<string, any>>(
operations?: Mutation<R>[],
): ObservableTransaction
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 ObservableTransaction
- Defined in src/SanityClient.ts:680

withConfig

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

Class ObservableSanityClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ObservableSanityClient

Properties

assets

datasets

listen

Type declaration

Type Parameters

Parameters

Returns Observable<MutationEvent<R>>

Type Parameters

Parameters

Returns Observable<ListenEvent<R>>

live

projects

users

Methods

action

Parameters

Returns Observable<SingleActionResult | MultipleActionResult>

clone

Returns ObservableSanityClient

config

Returns InitializedClientConfig

Parameters

Returns this

create

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Observable<SingleMutationResult>

Type Parameters

Parameters

Returns Observable<MultipleMutationResult>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

createIfNotExists

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Observable<SingleMutationResult>

Type Parameters

Parameters

Returns Observable<MultipleMutationResult>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

createOrReplace

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>[]>

Type Parameters

Parameters

Returns Observable<SingleMutationResult>

Type Parameters

Parameters

Returns Observable<MultipleMutationResult>

Type Parameters

Parameters