Comfy-Org/ComfyUI_frontend
1
0
Fork 0
mirror of https://github.com/Comfy-Org/ComfyUI_frontend.git synced 2026-05-23 14:16:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ext-api): add JSDoc remarks for declare function exports (CR-FIX-4)

Browse Source 
lifecycle.ts: clarify that defineNodeExtension, defineExtension, and
defineWidgetExtension are type-only exports for the npm package surface.
Runtime implementations are in extension-api-service.ts.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Connor Byrne
2026-05-13 15:46:43 -07:00
committed by bymyself
parent 25c76b98cf
commit 40c4fdae4c
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/extension-api/lifecycle.ts
View File

@@ -72,6 +72,11 @@ import type {
* }
* })
* ```
*
* @remarks
* This is a type-only export (`declare function`) for the npm package surface.
* The runtime implementation is in `extension-api-service.ts`. Bundlers that
* consume `@comfyorg/extension-api` will resolve to the service implementation.
*/
export declare function defineNode(
options: NodeExtensionOptions
@@ -95,6 +100,10 @@ export declare function defineNode(
* }
* })
* ```
*
* @remarks
* This is a type-only export (`declare function`) for the npm package surface.
* The runtime implementation is in `extension-api-service.ts`.
*/
export declare function defineExtension(
options: ExtensionOptions
@@ -115,6 +124,10 @@ export declare function defineExtension(
* type: 'COLOR_PICKER'
* })
* ```
*
* @remarks
* This is a type-only export (`declare function`) for the npm package surface.
* The runtime implementation is in `extension-api-service.ts`.
*/
export declare function defineWidget(
options: WidgetExtensionOptions