fix(docs): flatten types for typedoc #68
Merged
+853
−799
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
📚 TypeDoc Generation Result✅ TypeDoc generated successfully!
The TypeDoc JSON file has been generated and validated. All documentation scripts completed successfully. |
macdonst
reviewed
Feb 8, 2026
| * dayOfWeek: '*', | ||
| * }, | ||
| * name: 'daily-cleanup', | ||
| * event: {expression: 'every day at 9am'}, |
Contributor
There was a problem hiding this comment.
Should we have another example shows the cron expression as well?
defineScheduleFunction({
name: 'daily-cleanup',
event: {expression: '0 9 * * *'},
})
Member
Author
There was a problem hiding this comment.
I think so too. I will merge #69 into this and then move a couple examples around and see where we're at.
This function is still "@hidden" so there's opportunity to add more docs.
Member
Author
There was a problem hiding this comment.
Added!
Looks like this if it wasn't @hidden
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
macdonst
approved these changes
Feb 9, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
need to merge #69 first
use
@expandto help inline/flatten docs. particularly for all definer functions++ miscellaneous fixes and tuning
also "FUTURE example"s to show kitchen-sink+references. they may not work yet so they don't make it into the docs yet (
/*vs/**)bonus: upload generated HTML as an artifact of the PR. bummed I couldn't find a way to make it viewable in the browser yet. one day