Skip to content
WarmHub

PartialStreamSubmissionError

Error raised when a streamed commit submission fails after an ambiguous or partial append.

The completedOperations field contains returned rows the SDK knows completed. acknowledgedOperationCount also records progress when an append response contains sparse or empty result rows. Before retrying manually, inspect repository state because the failed append may have committed additional operations that were not reflected locally.

See

Section titled “See”

https://docs.warmhub.ai/sdk/transient-retry/#partial-submissions

Extends

Section titled “Extends”
  • Error

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new PartialStreamSubmissionError(input): PartialStreamSubmissionError

Parameters

Section titled “Parameters”
input
Section titled “input”
cause
Section titled “cause”

unknown

completedOperations
Section titled “completedOperations”

object[]

acknowledgedOperationCount?
Section titled “acknowledgedOperationCount?”

number

Returns

Section titled “Returns”

PartialStreamSubmissionError

Overrides

Section titled “Overrides”

Error.constructor

Properties

Section titled “Properties”

code

Section titled “code”

readonly code: "PARTIAL_STREAM_SUBMISSION" = 'PARTIAL_STREAM_SUBMISSION'

Stable error code. Always 'PARTIAL_STREAM_SUBMISSION'.

completedOperations

Section titled “completedOperations”

readonly completedOperations: object[]

Operations the SDK confirmed completed before the ambiguous or failing append. The remaining operations may or may not have landed; inspect repository state before retrying manually.

opIndex?

Section titled “opIndex?”

optional opIndex?: number

name

Section titled “name”

name: string

operation

Section titled “operation”

operation: unknown

dataHash

Section titled “dataHash”

dataHash: string

version

Section titled “version”

version: number

status?

Section titled “status?”

optional status?: "error" | "noop" | "applied"

error?

Section titled “error?”

optional error?: object

error.code
Section titled “error.code”

code: string

error.message
Section titled “error.message”

message: string

error.details?
Section titled “error.details?”

optional details?: { reason: "expected_version_mismatch"; expectedVersion: number; currentVersion: number; } | { reason: "lease_held"; leaseExpiresAt: string; } | { reason: "validation_failed"; issues: object[]; } | { reason: "rate_limit_reset"; retryAfterSeconds: number; resetAt: string; } | { reason: "cursor_fence_unavailable"; cause: "below_floor" | "above_head" | "not_ready"; retryFromStart: true; }

submittedName?

Section titled “submittedName?”

optional submittedName?: string

resolvedName?

Section titled “resolvedName?”

optional resolvedName?: string

retryable?

Section titled “retryable?”

optional retryable?: boolean

warnings?

Section titled “warnings?”

optional warnings?: object

Non-blocking warnings collected during shape validation — see GH-1418. Aliased to the generated wire shape so this type cannot drift from the backend’s streamMutationResultEntrySchema.warnings.

warnings.undeclaredFields?
Section titled “warnings.undeclaredFields?”

optional undeclaredFields?: string[]

warnings.undeclaredFieldsTruncated?
Section titled “warnings.undeclaredFieldsTruncated?”

optional undeclaredFieldsTruncated?: true

warnings.totalUndeclared?
Section titled “warnings.totalUndeclared?”

optional totalUndeclared?: number

warnings.coalescedWrefs?
Section titled “warnings.coalescedWrefs?”

optional coalescedWrefs?: object[]

warnings.coalescedWrefsTruncated?
Section titled “warnings.coalescedWrefsTruncated?”

optional coalescedWrefsTruncated?: true

warnings.totalCoalescedWrefs?
Section titled “warnings.totalCoalescedWrefs?”

optional totalCoalescedWrefs?: number

warnings.deprecations?
Section titled “warnings.deprecations?”

optional deprecations?: object[]

acknowledgedOperationCount

Section titled “acknowledgedOperationCount”

readonly acknowledgedOperationCount: number

Number of operations covered by append responses the SDK received before the failure. This can exceed completedOperations.length when the backend returns sparse or empty result rows.

cause

Section titled “cause”

readonly cause: unknown

Underlying error that triggered the partial submission, preserved for diagnostics. Inspect via isWarmHubError(err.cause) / err.cause.kind.

Overrides

Section titled “Overrides”

Error.cause