Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add JSDoc example #8533

Draft
wants to merge 19 commits into
base: master
Choose a base branch
from
+330 −74
Draft

feat: add JSDoc example #8533

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
602e5ea
feat: add example
linonetwo Aug 20, 2024
270aeba
chore: add ts file so tsc --noEmit works
linonetwo Sep 4, 2024
492d812
refactor: remove // @ts-check
linonetwo Sep 10, 2024
ac308e0
feat: Allow `import('$:/core/modules/...')` instead of `import('../..…
linonetwo Sep 10, 2024
b6f219a
feat: make $tw.wiki globally available
linonetwo Sep 10, 2024
a5feb38
feat: add an example jsdoc to $tw.wiki.getTiddlerText
linonetwo Sep 10, 2024
c5304b4
fix: Declaration emit for this file requires using private name 'Widg…
linonetwo Sep 10, 2024
43eff4e
fix: duplication of types
linonetwo Sep 10, 2024
cdceedd
docs: shorten JSDoc comment as requsted
linonetwo Sep 12, 2024
8f0d37e
refactor: move some type to base class
linonetwo Sep 12, 2024
24279cc
feat: allow type in /generated to work
linonetwo Sep 12, 2024
e3fc9b4
feat: import base type
linonetwo Sep 12, 2024
18517b6
refactor: generate types to /types/core instead for simplicity
linonetwo Sep 12, 2024
c56afea
feat: add ast type that wikiast is using
linonetwo Sep 12, 2024
06204b1
feat: refine the ast type
linonetwo Sep 12, 2024
0c92f1b
Update tw.d.ts
linonetwo Sep 12, 2024
562a308
fix: ignore base file
linonetwo Oct 30, 2024
3cc1849
Update wiki.js
linonetwo Oct 30, 2024
2eaadcd
Update npm-publish.sh
linonetwo Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions core/modules/wiki.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1494,9 +1494,13 @@ exports.search = function(text,options) {
return results;
};

/*
Trigger a load for a tiddler if it is skinny. Returns the text, or undefined if the tiddler is missing, null if the tiddler is being lazily loaded.
*/
/**
* Trigger a load for a tiddler if it is skinny. Returns the text, or undefined if the tiddler is missing, null if the tiddler is being lazily loaded.
*
* @param {string} title - The title of the tiddler.
* @param {string} [defaultText] - The default text to return if the tiddler is missing.
* @returns {string | null | undefined} - The text of the tiddler, undefined if the tiddler is missing, or null if the tiddler is being lazily loaded.
*/
Copy link
Member

@pmario pmario Sep 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

IMO the type text should be as short as possible, but still understandable. Your definition contains "undefined", which is not returned. So I would suggest:

/**
* Returns the tiddler text-field. If field `_is_skinny` is present it triggers a "lazyLoad" event.
* 
* @param {string} title - Tiddler title
* @param {string} [defaultText] - Returned if tiddler is missing
* @returns {string | null } - Returns the "text-field" or an empty string, "defaultText" if the tiddler is missing or null if the tiddler is being lazily loaded
*/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When add @returns, it means it always return, so can't remove undefined here. It is same in TypeScript.

exports.getTiddlerText = function(title,defaultText) {
var tiddler = this.getTiddler(title);
// Return undefined if the tiddler isn't found
Expand Down
Loading