Class ObservableTransaction

Hierarchy (View Summary)

BaseTransaction
- ObservableTransaction

Index

Constructors

constructor

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

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(): ObservableTransaction
Clones the transaction

Returns ObservableTransaction
- Defined in src/data/transaction.ts:282

commit

commit<R extends Record<string, any>>(
options: TransactionFirstDocumentMutationOptions,
): Observable<SanityDocument<R>>
Commit the transaction, returning an observable that produces the first mutated document
Type Parameters
- R extends Record<string, any>
Parameters
- options: TransactionFirstDocumentMutationOptions
  Options for the mutation operation
Returns Observable<SanityDocument<R>>
- Defined in src/data/transaction.ts:291
commit<R extends Record<string, any>>(
options: TransactionAllDocumentsMutationOptions,
): Observable<SanityDocument<R>[]>
Commit the transaction, returning an observable that produces an array of the mutated documents
Type Parameters
- R extends Record<string, any>
Parameters
- options: TransactionAllDocumentsMutationOptions
  Options for the mutation operation
Returns Observable<SanityDocument<R>[]>
- Defined in src/data/transaction.ts:299
commit(
options: TransactionFirstDocumentIdMutationOptions,
): Observable<SingleMutationResult>
Commit the transaction, returning an observable that produces a mutation result object
Parameters
- options: TransactionFirstDocumentIdMutationOptions
  Options for the mutation operation
Returns Observable<SingleMutationResult>
- Defined in src/data/transaction.ts:307
commit(
options: TransactionAllDocumentIdsMutationOptions,
): Observable<MultipleMutationResult>
Commit the transaction, returning an observable that produces a mutation result object
Parameters
- options: TransactionAllDocumentIdsMutationOptions
  Options for the mutation operation
Returns Observable<MultipleMutationResult>
- Defined in src/data/transaction.ts:313
commit(options?: BaseMutationOptions): Observable<MultipleMutationResult>
Commit the transaction, returning an observable that produces a mutation result object
Parameters
- Optionaloptions: BaseMutationOptions
  Options for the mutation operation
Returns Observable<MultipleMutationResult>
- Defined in src/data/transaction.ts:319

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 | ObservablePatchBuilder,
): 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 | ObservablePatchBuilder
  Operations to perform, or a builder function
Returns this
- Defined in src/data/transaction.ts:350
patch(patch: ObservablePatch): 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: ObservablePatch
  ObservablePatch to execute
Returns this
- Defined in src/data/transaction.ts:357

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 ObservableTransaction

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ObservableTransaction

Properties

Protectedoperations

Protected OptionaltrxId

Methods

Protected_add

Parameters

Returns this

clone

Returns ObservableTransaction

commit

Type Parameters

Parameters

Returns Observable<SanityDocument<R>>

Type Parameters

Parameters

Returns Observable<SanityDocument<R>[]>

Parameters

Returns Observable<SingleMutationResult>

Parameters

Returns Observable<MultipleMutationResult>

Parameters

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

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