Skip to Content

The BatchUpdateEntry type of the TypeScript SDK, part of BatchUpdateResult.

type BatchUpdateEntry = {
  currentModseq?: number
  expungedAt?: number
  id: string
  labelsAdded?: string[]
  labelsRemoved?: string[]
  message?: MessageMeta
  modified?: boolean
  modseq?: number
  purgeAfter?: number
  status: ('updated' | 'expunged' | 'not_found' | 'not_in_label' | 'too_many_keywords' | 'modified')
}

Fields

FieldTypeDescription
currentModseqnumberOptional. Current message MODSEQ value on CAS conflict
expungedAtnumberOptional. Expunge timestamp in epoch seconds (when status=expunged)
idstringMessage ULID
labelsAddedstring[]Optional. Labels attached by this write
labelsRemovedstring[]Optional. Labels detached by this write
messageMessageMetaOptional. Updated message metadata (when status=updated)
modifiedbooleanOptional. True if CAS check failed due to concurrent modification
modseqnumberOptional. Updated or current MODSEQ value
purgeAfternumberOptional. Purge deadline timestamp in epoch seconds (when status=expunged)
status('updated' | 'expunged' | 'not_found' | 'not_in_label' | 'too_many_keywords' | 'modified')Outcome status for this message. not_in_label: the patch named a flagLabel this message is not filed in, so nothing was written for it

Used in

BatchUpdateResult.

On this page