Skip to content

Commit f0818d8

Browse files
docs(components): add v5.1.3 changed badge to scope.close()
Review feedback on #647: scope.close() awaits promises returned by 'close' listeners as of v5.1.3 (v5.1.2 emitted 'close' without awaiting). Per CONTRIBUTING.md, behavior changes to existing surface get a standalone <VersionBadge type="changed" /> below the heading. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent be7cf32 commit f0818d8

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

reference/components/plugin-api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,8 @@ Returns: `string` — Root directory of the application component (where `config
189189

190190
#### `scope.close()`
191191

192+
<VersionBadge type="changed" version="v5.1.3" />
193+
192194
Closes all associated entry handlers and the `scope.options` instance, emits `'close'`, and removes all listeners. Promises returned by `'close'` listeners are awaited before it resolves.
193195

194196
Plugins rarely call this directly. Harper calls it on each worker thread during shutdown and graceful restart — see [Cleanup on Shutdown](#cleanup-on-shutdown).

0 commit comments

Comments
 (0)