Class Transaction

Hierarchy (View Summary)

BaseTransaction
- Transaction

Index

Constructors

constructor

new Transaction(
    operations?: Mutation[],
    client?: SanityClient,
    transactionId?: string,
): Transaction
Parameters
- Optionaloperations: Mutation[]
- Optionalclient: SanityClient
- OptionaltransactionId: string
Returns Transaction
Overrides BaseTransaction.constructor
- Defined in src/data/transaction.ts:140

Properties

`Protected`operations

operations: Mutation[]

`Protected` `Optional`trxId

trxId?: string

Methods

`Protected`_add

_add(mut: Mutation): this
Parameters
- mut: Mutation
Returns this
Inherited from BaseTransaction._add
- Defined in src/data/transaction.ts:131

clone

clone(): Transaction
Clones the transaction

Returns Transaction
- Defined in src/data/transaction.ts:148

commit

commit<R extends Record<string, any>>(
options: TransactionFirstDocumentMutationOptions,
): Promise<SanityDocument<R>>
Commit the transaction, returning a promise that resolves to the first mutated document
Type Parameters
- R extends Record<string, any>
Parameters
- options: TransactionFirstDocumentMutationOptions
  Options for the mutation operation
Returns Promise<SanityDocument<R>>
- Defined in src/data/transaction.ts:157
commit<R extends Record<string, any>>(
options: TransactionAllDocumentsMutationOptions,
): Promise<SanityDocument<R>[]>
Commit the transaction, returning a promise that resolves to an array of the mutated documents
Type Parameters
- R extends Record<string, any>
Parameters
- options: TransactionAllDocumentsMutationOptions
  Options for the mutation operation
Returns Promise<SanityDocument<R>[]>
- Defined in src/data/transaction.ts:165
commit(
options: TransactionFirstDocumentIdMutationOptions,
): Promise<SingleMutationResult>
Commit the transaction, returning a promise that resolves to a mutation result object
Parameters
- options: TransactionFirstDocumentIdMutationOptions
  Options for the mutation operation
Returns Promise<SingleMutationResult>
- Defined in src/data/transaction.ts:173
commit(
options: TransactionAllDocumentIdsMutationOptions,
): Promise<MultipleMutationResult>
Commit the transaction, returning a promise that resolves to a mutation result object
Parameters
- options: TransactionAllDocumentIdsMutationOptions
  Options for the mutation operation
Returns Promise<MultipleMutationResult>
- Defined in src/data/transaction.ts:179
commit(options?: BaseMutationOptions): Promise<MultipleMutationResult>
Commit the transaction, returning a promise that resolves to a mutation result object
Parameters
- Optionaloptions: BaseMutationOptions
  Options for the mutation operation
Returns Promise<MultipleMutationResult>
- Defined in src/data/transaction.ts:185

create

create<R extends Record<string, any> = Record<string, any>>(
doc: SanityDocumentStub<R>,
): this
Creates a new Sanity document. If _id is provided and already exists, the mutation will fail. If no _id is given, one will automatically be generated by the database. The operation is added to the current transaction, ready to be commited by commit()
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- doc: SanityDocumentStub<R>
  Document to create. Requires a _type property.
Returns this
Inherited from BaseTransaction.create
- Defined in src/data/transaction.ts:44

createIfNotExists

createIfNotExists<R extends Record<string, any> = Record<string, any>>(
doc: IdentifiedSanityDocumentStub<R>,
): this
Creates a new Sanity document. If a document with the same _id already exists, the create operation will be ignored. The operation is added to the current transaction, ready to be commited by commit()
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- doc: IdentifiedSanityDocumentStub<R>
  Document to create if it does not already exist. Requires _id and _type properties.
Returns this
Inherited from BaseTransaction.createIfNotExists
- Defined in src/data/transaction.ts:55

createOrReplace

createOrReplace<R extends Record<string, any> = Record<string, any>>(
doc: IdentifiedSanityDocumentStub<R>,
): this
Creates a new Sanity document, or replaces an existing one if the same _id is already used. The operation is added to the current transaction, ready to be commited by commit()
Type Parameters
- R extends Record<string, any> = Record<string, any>
Parameters
- doc: IdentifiedSanityDocumentStub<R>
  Document to create or replace. Requires _id and _type properties.
Returns this
Inherited from BaseTransaction.createOrReplace
- Defined in src/data/transaction.ts:70

delete

delete(documentId: string): this
Deletes the document with the given document ID The operation is added to the current transaction, ready to be commited by commit()
Parameters
- documentId: string
  Document ID to delete
Returns this
Inherited from BaseTransaction.delete
- Defined in src/data/transaction.ts:85

patch

patch(documentId: string, patchOps?: PatchOperations | PatchBuilder): this
Performs a patch on the given document ID. Can either be a builder function or an object of patch operations. The operation is added to the current transaction, ready to be commited by commit()
Parameters
- documentId: string
  Document ID to perform the patch operation on
- OptionalpatchOps: PatchOperations | PatchBuilder
  Operations to perform, or a builder function
Returns this
- Defined in src/data/transaction.ts:216
patch(patch: MutationSelection, patchOps?: PatchOperations | PatchBuilder): this
Performs a patch on the given selection. Can either be a builder function or an object of patch operations.
Parameters
- patch: MutationSelection
- OptionalpatchOps: PatchOperations | PatchBuilder
  Operations to perform, or a builder function
Returns this
- Defined in src/data/transaction.ts:223
patch(patch: Patch): this
Adds the given patch instance to the transaction. The operation is added to the current transaction, ready to be commited by commit()
Parameters
- patch: Patch
  Patch to execute
Returns this
- Defined in src/data/transaction.ts:230

reset

reset(): this
Clears the transaction of all operations

Returns this
Inherited from BaseTransaction.reset
- Defined in src/data/transaction.ts:126

serialize

serialize(): Mutation[]
Return a plain JSON representation of the transaction

Returns Mutation[]
Inherited from BaseTransaction.serialize
- Defined in src/data/transaction.ts:112

toJSON

toJSON(): Mutation[]
Return a plain JSON representation of the transaction

Returns Mutation[]
Inherited from BaseTransaction.toJSON
- Defined in src/data/transaction.ts:119

transactionId

transactionId(): undefined | string
Gets the current transaction ID, if any

Returns undefined | string
Inherited from BaseTransaction.transactionId
- Defined in src/data/transaction.ts:93
transactionId(id: string): this
Set the ID of this transaction.
Parameters
- id: string
  Transaction ID
Returns this
Inherited from BaseTransaction.transactionId
- Defined in src/data/transaction.ts:99

Class Transaction

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Transaction

Properties

Protectedoperations

Protected OptionaltrxId

Methods

Protected_add

Parameters

Returns this

clone

Returns Transaction

commit

Type Parameters

Parameters

Returns Promise<SanityDocument<R>>

Type Parameters

Parameters

Returns Promise<SanityDocument<R>[]>

Parameters

Returns Promise<SingleMutationResult>

Parameters

Returns Promise<MultipleMutationResult>

Parameters

Returns Promise<MultipleMutationResult>

create

Type Parameters

Parameters

Returns this

createIfNotExists

Type Parameters

Parameters

Returns this

createOrReplace

Type Parameters

Parameters

Returns this

delete

Parameters

Returns this

patch

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

reset

Returns this

serialize

Returns Mutation[]

toJSON

Returns Mutation[]

transactionId

Returns undefined | string

Parameters

Returns this

Settings

On This Page

`Protected`operations

`Protected` `Optional`trxId

`Protected`_add