Document apiReferenceHistory

history.endGroup

Finish the matching editor-local group. Call in finally after awaiting each write. A stale handle returns closed false when no group is active; a mismatched handle cannot close another active group. Successful writes become one Undo and one Redo without rolling back failed writes.

read-onlyidempotent
doc.history.endGroup(…)

Expected result

Returns the supplied groupId and closed, indicating whether this call closed an active group.

Inputs

groupIdstringrequired

Result

Output fields
groupIdstringrequired
closedbooleanrequired

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • PRECONDITION_FAILED

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas