Function editDocument

Creates an EditDocumentAction object with patches for modifying a document. This is the implementation signature and handles the different patch input types.

Param: doc

A handle uniquely identifying the document to be edited.

Param: patches

Patches in various formats (PatchOperations, PatchOperations[], or SanityMutatePatchMutation).

Param: options

Options controlling how the patches are processed.

Returns

An EditDocumentAction object ready for dispatch.

editDocument<
    TDocumentType extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
>(
    doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
    sanityMutatePatch: PatchMutation,
    options?: EditDocumentOptions,
): EditDocumentAction<TDocumentType, TDataset, TProjectId>
Beta
Creates an EditDocumentAction object with patches for modifying a document. Accepts patches in either the standard PatchOperations format or as a SanityMutatePatchMutation from @sanity/mutate.
Type Parameters
- TDocumentType extends string = string
- TDataset extends string = string
- TProjectId extends string = string
Parameters
- doc: DocumentHandle<TDocumentType, TDataset, TProjectId>
  A handle uniquely identifying the document to be edited.
- sanityMutatePatch: PatchMutation
  A patch mutation object from @sanity/mutate.
- Optionaloptions: EditDocumentOptions
  Options controlling how the patches are processed.
Returns EditDocumentAction<TDocumentType, TDataset, TProjectId>
An EditDocumentAction object ready for dispatch.
- Defined in document/actions.ts:241
editDocument<
    TDocumentType extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
>(
    doc: DocumentHandle<TDocumentType, TDataset, TProjectId>,
    patches?: PatchOperations | PatchOperations[],
    options?: EditDocumentOptions,
): EditDocumentAction<TDocumentType, TDataset, TProjectId>
Beta
Creates an EditDocumentAction object with patches for modifying a document.
Type Parameters
- TDocumentType extends string = string
- TDataset extends string = string
- TProjectId extends string = string
Parameters
- doc: DocumentHandle<TDocumentType, TDataset, TProjectId>
  A handle uniquely identifying the document to be edited.
- Optionalpatches: PatchOperations | PatchOperations[]
  A single patch operation or an array of patch operations.
- Optionaloptions: EditDocumentOptions
  Options controlling how the patches are processed.
Returns EditDocumentAction<TDocumentType, TDataset, TProjectId>
An EditDocumentAction object ready for dispatch.
- Defined in document/actions.ts:259