Class BaseTransactionInternal

Hierarchy (View Summary)

Constructors

constructor

Properties

operations trxId?

Methods

_add create createIfNotExists createOrReplace delete reset serialize toJSON transactionId

Constructors

constructor

Properties

Protectedoperations

operations: Mutation[]

Protected OptionaltrxId

trxId?: string

Methods

Protected_add

  • _add(mut: Mutation): this

    Parameters

    Returns this

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

    Returns this

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

    Returns this

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

    Returns this

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

reset

  • reset(): this

    Clears the transaction of all operations

    Returns this

serialize

  • serialize(): Mutation[]

    Return a plain JSON representation of the transaction

    Returns Mutation[]

toJSON

  • toJSON(): Mutation[]

    Return a plain JSON representation of the transaction

    Returns Mutation[]

transactionId

  • transactionId(): undefined | string

    Gets the current transaction ID, if any

    Returns undefined | string

  • transactionId(id: string): this

    Set the ID of this transaction.

    Parameters

    • id: string

      Transaction ID

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods