Skip to content

fill out JSDOc for most public APIs#81

Open
jbolda wants to merge 2 commits intomainfrom
jsdoc
Open

fill out JSDOc for most public APIs#81
jbolda wants to merge 2 commits intomainfrom
jsdoc

Conversation

@jbolda
Copy link
Collaborator

@jbolda jbolda commented Jan 24, 2026

Motivation

Better helpers in our IDE which is always nice. We could generate a TypeDoc site from this as well if we would so choose.

@jbolda jbolda requested review from VldMrgnn and neurosnap January 24, 2026 07:18
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 24, 2026

More templates

npm i https://pkg.pr.new/fxforge/starfx@81

commit: 2e02f8f

* } else {
* console.error(result.error);
* }
* const result = yield* safe(() => fetch('https://api.example.com/users'));
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Basic usage" example won't compile. safe() expects () => Operation, but fetch() returns a Promise.
// Current (incorrect)
const result = yield* safe(() => fetch('https://api.example.com/users'));

// Should be
const result = yield* safe(function* () {
return yield* until(fetch('https://api.example.com/users'));
});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants