[PR #29] [MERGED] docs: TSDoc for the public API members that had none #39

New issue

Closed

opened 2026-10-31 22:04:02 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:04:02 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/29
Author: @robinjhuang
Created: 7/30/2026
Status: ✅ Merged
Merged: 7/30/2026
Merged by: @wei-hai

Base: main ← Head: docs/public-api-tsdoc

📝 Commits (1)

11d0d22 docs: TSDoc for the public API members that had none

📊 Changes

5 files changed (+105 additions, -0 deletions)

View changed files

📝 src/sdk/assets.ts (+21 -0)
📝 src/sdk/client.ts (+9 -0)
📝 src/sdk/jobs.ts (+34 -0)
📝 src/sdk/outputs.ts (+29 -0)
📝 src/sdk/workflows.ts (+12 -0)

📄 Description

In TypeScript the doc comment is the discovery mechanism — it's what the editor shows on hover and what ships inside the .d.ts — and the gaps were in the least guessable places: the range tuple on Output.toFile/toBytes is inclusive of both ends, Job.getOutputs reads state already on the handle rather than re-fetching (and returns [] for an unknown node instead of throwing), Job.cancel is a request rather than a guarantee, and Asset.createdNew distinguishes uploaded from server-deduped. Comfy, Job, Output, Workflow and Asset had no class doc at all, so hovering the main entry points showed nothing.

Public methods/getters documented goes from 15/38 to 38/38; no behaviour change.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-typescript-sdk/pull/29 **Author:** [@robinjhuang](https://github.com/robinjhuang) **Created:** 7/30/2026 **Status:** ✅ Merged **Merged:** 7/30/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `docs/public-api-tsdoc` --- ### 📝 Commits (1) - [`11d0d22`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/11d0d22e6c05b9aa080061e0b6a9ec923c554f0e) docs: TSDoc for the public API members that had none ### 📊 Changes **5 files changed** (+105 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `src/sdk/assets.ts` (+21 -0) 📝 `src/sdk/client.ts` (+9 -0) 📝 `src/sdk/jobs.ts` (+34 -0) 📝 `src/sdk/outputs.ts` (+29 -0) 📝 `src/sdk/workflows.ts` (+12 -0) </details> ### 📄 Description In TypeScript the doc comment *is* the discovery mechanism — it's what the editor shows on hover and what ships inside the `.d.ts` — and the gaps were in the least guessable places: the `range` tuple on `Output.toFile`/`toBytes` is inclusive of both ends, `Job.getOutputs` reads state already on the handle rather than re-fetching (and returns `[]` for an unknown node instead of throwing), `Job.cancel` is a request rather than a guarantee, and `Asset.createdNew` distinguishes uploaded from server-deduped. `Comfy`, `Job`, `Output`, `Workflow` and `Asset` had no class doc at all, so hovering the main entry points showed nothing. Public methods/getters documented goes from 15/38 to 38/38; no behaviour change. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:04:02 +00:00