Closed
Conversation
Contributor
WalkthroughDocumentation updates across installation guides, changelog, and generated API reference files. Go version bumped to 1.25, CLI tool references changed from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 18
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
🤖 Fix all issues with AI agents
In `@docs/src/content/docs/quick-start/installation.mdx`:
- Around line 145-151: Update the Fedora TabItem to handle Fedora 39
compatibility: either replace the single install line under TabItem
label="Fedora" with a short note and two commands (Fedora 39: use
webkit2gtk4.0-devel; Fedora 40+: use webkit2gtk4.1-devel) or explicitly state a
minimum requirement of Fedora 40 and keep the existing command using
webkit2gtk4.1-devel; edit the Fedora TabItem content around the existing sudo
dnf install gcc pkg-config gtk3-devel webkit2gtk4.1-devel line to reflect the
chosen approach.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Hide.html:
- Line 2: The "Defined in" source link in the generated docs for
Application.Hide incorrectly points to the fork (AbdelhadiSeddar/wails); update
the TypeDoc/source link configuration or the source reference generation so the
link uses the official repository (wailsapp/wails) for the Application.Hide
entry (and likewise for System.invoke.html), ensuring the anchor points
(src/application.ts:21) remain unchanged while replacing the repository owner in
the URL.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Quit.html:
- Line 2: The generated docs page Application.Quit.html incorrectly links
"Defined in" to the forked repo; update the TypeDoc/source mapping so the source
link for the Application.Quit entry points to the canonical repository
(wailsapp/wails). Locate the doc generation/config (TypeDoc config or the code
that sets the sourceUrlBase) and change the source root or repository URL used
for src/application.ts (the symbol Application.Quit / src/application.ts
reference) to the correct wailsapp/wails repo so all "Defined in" links resolve
to the original repository.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Show.html:
- Line 2: The "Defined in" source link in the generated docs for
Application.Show points to the forked repo (AbdelhadiSeddar/wails); update the
source URL mapping so generated links use the canonical repo (wailsapp/wails).
Locate where source links are produced for docs generation (the TypeDoc/source
template or the config that emits the "Defined in" anchor for Application.Show)
and replace the forked repo base URL with https://github.com/wailsapp/wails
(affecting the generated "Defined in" anchors across functions like
Application.Show). Regenerate the docs so the HTML
(functions/Application.Show.html) contains the corrected repository link.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Browser.OpenURL.html:
- Around line 1-3: The HTML docs under
v3/internal/runtime/desktop/@wailsio/runtime/docs (e.g., Browser.OpenURL.html)
contain source links pointing to the contributor fork (AbdelhadiSeddar/wails);
regenerate the TypeDoc output so links use the correct repository
(wailsapp/wails) from package.json. Run your TypeDoc generation step for that
package (the same command used for other regenerated docs), verify the "Defined
in" source URLs now point to wailsapp/wails, and commit the regenerated files
(replace the 80 affected files in
v3/internal/runtime/desktop/@wailsio/runtime/docs). Ensure no manual edits to
HTML—rebuild via TypeDoc so the repository metadata in package.json is applied.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Dialogs.Info.html:
- Line 4: The generated docs file shows the "Defined in" source link pointing to
the fork (AbdelhadiSeddar/wails) for the Dialogs.Info entry (see referenced
src/dialogs.ts:140); fix by regenerating or reverting the generated docs so the
source links point to the canonical wailsapp/wails repo (ensure TypeDoc config
or repo remote is set to wailsapp/wails before running generation), or revert
changes to
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Dialogs.Info.html if
documentation wasn’t meant to change.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Dialogs.SaveFile.html:
- Line 4: The generated docs contain a bad "Defined in" source link pointing at
your fork; update the source URL in the generated HTML for Dialogs.SaveFile
(docs/functions/Dialogs.SaveFile.html) to use the official repository path
(replace AbdelhadiSeddar/wails with wailsapp/wails) or regenerate the docs after
switching the local git remote to the upstream repository so src/dialogs.ts (the
definition at src/dialogs.ts:183) is linked to
https://github.com/wailsapp/wails/... instead of your fork.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Dialogs.Warning.html:
- Line 4: The generated TypeDoc HTML files in
v3/internal/runtime/desktop/@wailsio/runtime/docs/ incorrectly reference your
fork (AbdelhadiSeddar/wails); regenerate the docs with the correct repository
configuration by ensuring package.json repository is set to "wailsapp/wails" and
any TypeDoc config (typedoc.json or build script) does not override it, then run
the docs build script (npm run build:docs) to rebuild all 77 HTML files so links
point to wailsapp/wails.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Events.OnMultiple.html:
- Line 6: The "Defined in" source link in the generated doc
(Events.OnMultiple.html) points to the forked repo (AbdelhadiSeddar/wails)
instead of the canonical wailsapp/wails; update the URL in the generated TypeDoc
output so the anchor for src/events.ts (referenced at src/events.ts:112) uses
https://github.com/wailsapp/wails/... rather than the fork, and then regenerate
or replace all other TypeDoc-generated files with corrected source links; also
decide whether to remove generated docs from version control and instead add doc
generation to the build/release pipeline so this source reference issue cannot
recur.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/loadOptionalScript.html:
- Line 4: The generated TypeDoc HTML files (e.g., the loadOptionalScript.html
entry) contain "Defined in" links pointing to a contributor fork instead of the
canonical repo because docs were built with the wrong repository origin; fix by
regenerating the docs using the canonical repository setting (ensure the
repository field used by TypeDoc/typedoc.json or the TypeDoc CLI is set to
"github.com/wailsapp/wails") and commit the regenerated files, or if docs
weren’t meant to be part of this PR, remove the generated docs from the change
set so that they are not merged; locate the TypeDoc/typedoc.json config and the
generated runtime docs output (the `@wailsio/runtime` docs) and update/regenerate
accordingly.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/System.invoke.html:
- Line 1: The generated docs' "Defined in" links point to your fork
(AbdelhadiSeddar/wails) instead of the official repo; fix by regenerating or
reverting the generated HTML so links reference wailsapp/wails. Locate the docs
for System.invoke (invoke in System, see the "Defined in" source reference
pointing at src/system.ts:42) and update the generation step or undo the
generated changes across all HTML files so the source URL base is the official
repository (wailsapp/wails) rather than the fork.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/System.IsLinux.html:
- Line 3: The generated TypeDoc "Defined in" links point to your fork
(AbdelhadiSeddar/wails) instead of the canonical repository; fix by regenerating
or reverting the docs: update the TypeDoc/tsconfig (or package.json)
repository/url settings to the upstream canonical repo (wailsapp/wails) and
re-run the doc build so references for symbols like System.IsLinux (defined in
src/system.ts at the referenced location) point to the correct upstream origin,
or simply revert the auto-generated documentation changes from this PR if the
doc regeneration was accidental.
In `@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/WML.Reload.html:
- Line 2: The generated docs contain "Defined in" links pointing to the fork
(AbdelhadiSeddar/wails); update the TypeDoc sourceLink/base URL and regenerate
so links point to the canonical repo (wailsapp/wails). Locate the doc files like
WML.Reload.html (references src/wml.ts:206) and fix by either updating your
TypeDoc config (typedoc.json or the build script) to use the correct
repository/base URL or by regenerating the docs from the main wailsapp/wails
checkout, then commit the regenerated HTML.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/CancellablePromiseWithResolvers.html:
- Around line 1-7: The generated TypeDoc HTML files under
v3/internal/runtime/desktop/@wailsio/runtime/docs/ contain "Defined in" links
pointing to the personal fork (e.g., links like the one for src/cancellable.ts
shown in CancellablePromiseWithResolvers.html) because the repo remote used
during docs generation is incorrect; fix this by updating the git remote to the
canonical repository (set origin to https://github.com/wailsapp/wails or ensure
`git remote get-url origin` returns that), then regenerate the TypeDoc output
(re-run your TypeDoc/typedoc generation step) so all "Defined in"/source links
in files such as CancellablePromiseWithResolvers.html and other docs reference
the wailsapp/wails repository instead of AbdelhadiSeddar's fork.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/Dialogs.MessageDialogOptions.html:
- Line 1: The generated docs for symbols like MessageDialogOptions show "Defined
in" links pointing at your fork (AbdelhadiSeddar) because TypeDoc was built with
the local git remote set to your fork; fix by regenerating the docs after
configuring the git remote to the official repository (or by setting the
repository/source link in the TypeDoc config to
https://github.com/wailsapp/wails) so the "Defined in" links for
MessageDialogOptions and other symbols point to the upstream repo.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/IOS.Device.Info.html:
- Line 1: The generated TypeDoc HTML contains "Defined in" links pointing to the
personal fork URL (AbdelhadiSeddar/wails) instead of the official wailsapp/wails
repo; fix by regenerating the docs after updating the git remote or TypeDoc
config to the canonical repo URL so links like those referencing src/ios.ts
(e.g., the Info interface defined in src/ios.ts) point to
https://github.com/wailsapp/wails/; specifically, set git remote origin to
https://github.com/wailsapp/wails.git (or set the repository option in TypeDoc)
and then re-run the documentation generation so all instances of the fork URL
are replaced with the official repository URL.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/RuntimeTransport.html:
- Line 4: The generated TypeDoc HTML includes source links pointing to your fork
(e.g., the "Defined in" link shown on the RuntimeTransport page) because docs
were built from your local fork; remove or regenerate those artifacts: either
(a) revert/remove the generated docs from this PR so CI can produce them, or (b)
rebuild the docs with TypeDoc configured to use the upstream repository by
setting the gitRemote/gitRevision options to "wailsapp/wails" (or correct repo),
and then commit the regenerated files; look for the RuntimeTransport HTML and
the TypeDoc config (typedoc options in your build/typedoc config or
src/runtime.ts reference) to apply the fix.
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/Screens.Rect.html:
- Around line 1-9: The generated docs source links point to your fork
(AbdelhadiSeddar/wails) instead of the upstream repo; fix by updating the
repository remote or TypeDoc config and regenerating the docs: either set your
local git origin to the upstream wailsapp/wails (so TypeDoc picks correct repo)
or set TypeDoc's gitRemote option to "https://github.com/wailsapp/wails" in your
typedoc.json, then re-run the doc generation and verify "Defined in" links
(e.g., the Screens.Rect / src/screens.ts references) now point to wailsapp/wails
before committing.
🟡 Minor comments (30)
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.Environment.html-3-3 (1)
3-3: Use the canonical repo for “Defined in” source links.Pointing docs to a contributor fork (
AbdelhadiSeddar/wails) risks broken or misleading links. Please revert to the official repo (e.g.,wailsapp/wails) or ensure the doc generator uses the canonical origin.v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsMac.html-3-3 (1)
3-3: Source link points to contributor's fork instead of upstream repository.The "Defined in" link references
AbdelhadiSeddar/wailsinstead of the canonicalwailsapp/wailsrepository. This appears to be an unintentional side effect of regenerating the TypeDoc documentation from your fork.The link should point to:
https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L120Consider regenerating the docs after updating your git remote or configuring TypeDoc to use the correct repository URL. The AI summary indicates this same issue affects multiple generated doc files.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/WML.Enable.html-2-2 (1)
2-2: Source link incorrectly references contributor's fork instead of official repository.The "Defined in" link points to
https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/...instead of the officialhttps://github.com/wailsapp/wails/blob/v3-alpha/.... This appears to be an unintended artifact from regenerating documentation in a forked environment.Per the AI summary, this pattern repeats across many generated doc files. Consider regenerating the documentation with the correct upstream repository reference, or reverting these generated file changes if they weren't intended as part of this PR's scope (version number fixes and wails/wails3 usage).
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/IOS.Device.Info-1.html-1-1 (1)
1-1: Use canonical repo in “Defined in” source link.Linking to a personal fork in generated docs is misleading and risks broken references. Please point back to the upstream repository.
🔧 Suggested fix
-<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L33">src/ios.ts:33</a></li></ul></aside> +<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L33">src/ios.ts:33</a></li></ul></aside>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Screens.GetPrimary.html-3-3 (1)
3-3: Use canonical repo for “Defined in” source links.This should reference the upstream repository for stability and correct attribution.
🧭 Proposed fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L77">src/screens.ts:77</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L77">src/screens.ts:77</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Screens.GetCurrent.html-3-3 (1)
3-3: Use canonical repo for “Defined in” source links.Please point to the upstream repo to keep docs stable and avoid broken links.
🧭 Proposed fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L86">src/screens.ts:86</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L86">src/screens.ts:86</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Screens.GetAll.html-3-3 (1)
3-3: Use canonical repo for “Defined in” source links.Pointing docs to a contributor fork risks 404s and attribution mismatch. Please restore the upstream link (wailsapp/wails) for stable references.
🧭 Proposed fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L68">src/screens.ts:68</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L68">src/screens.ts:68</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsDarkMode.html-3-3 (1)
3-3: Source link incorrectly points to contributor's fork instead of official repository.The "Defined in" link references
AbdelhadiSeddar/wails(your fork) rather than the officialwailsapp/wailsrepository. This appears to be an artifact of regenerating TypeDoc documentation from your fork's local environment.When merged, documentation should reference the canonical source at
https://github.com/wailsapp/wails/.... Consider either:
- Regenerating the docs after configuring TypeDoc to use the upstream repository URL, or
- Excluding auto-generated documentation files from this PR if they weren't intentionally modified.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Flags.GetFlag.html-4-4 (1)
4-4: Source link incorrectly points to contributor's fork instead of main repository.The "Defined in" link references
github.com/AbdelhadiSeddar/wails(your fork) rather than the canonicalgithub.com/wailsapp/wailsrepository. This appears to be an unintentional artifact from regenerating TypeDoc documentation while working on your fork.These links should point to the main repository to ensure they remain stable and don't break if the fork is modified or deleted. Consider regenerating the docs after updating your git remote configuration, or avoid committing auto-generated documentation changes that only affect source attribution.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/IOS.Haptics.Impact.html-1-1 (1)
1-1: Incorrect source repository reference.The
Defined inlink points toAbdelhadiSeddar/wails(your fork) instead of the officialwailsapp/wailsrepository. This appears to be an unintended side effect of regenerating the TypeDoc documentation from your fork.The link should reference:
https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L21Consider reverting this auto-generated documentation file or regenerating it after merging upstream changes so the source links point to the official repository.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Events.Emit.html-5-5 (1)
5-5: Source links incorrectly reference contributor's fork instead of official repository.The "Defined in" source links point to
AbdelhadiSeddar/wails(contributor's fork) rather than the officialwailsapp/wailsrepository. This appears to be an artifact from regenerating TypeDoc documentation in your local environment.Please regenerate these docs with the correct repository reference configured, or revert these generated files if they were unintentionally included in the PR.
Also applies to: 8-8
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Events.Off.html-3-3 (1)
3-3: Source link points to a contributor fork instead of canonical repo.Line 3’s “Defined in” link targets
AbdelhadiSeddar/wails. For published docs, this should typically point to the canonicalwailsapp/wailsrepo to avoid stale/404 links after the PR is merged. If this file is generated, please fix the TypeDoc source URL config and re‑generate rather than editing HTML directly.🔧 Suggested change (if editing HTML directly)
-<a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/events.ts#L147">src/events.ts:147</a> +<a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/events.ts#L147">src/events.ts:147</a>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsWindows.html-3-3 (1)
3-3: Use canonical repo for “Defined in” source links.Pointing docs at a contributor fork risks stale/broken attribution if the fork is deleted. Prefer the canonical
wailsapp/wailsrepo, and if these pages are generated, update the TypeDoc repo URL so regeneration doesn’t revert it.🔧 Suggested fix
-<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L102">src/system.ts:102</a></li></ul></aside> +<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L102">src/system.ts:102</a></li></ul></aside>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.Capabilities.html-3-3 (1)
3-3: Use the canonical repository in the “Defined in” link.Line 3 points to a personal fork (
AbdelhadiSeddar/wails). For published docs, this should generally point to the upstream repo (wailsapp/wails) to avoid broken links and misattribution. Consider reverting the URL or updating the generator config that emits these links.🔧 Suggested fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L60">src/system.ts:60</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L60">src/system.ts:60</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>v3/internal/runtime/desktop/@wailsio/runtime/docs/interfaces/Events.CustomEvents.html-3-3 (1)
3-3: Keep “Defined in” link pointing to the canonical repo.Line 3 links to the contributor fork (
AbdelhadiSeddar/wails). For published docs, this should remainwailsapp/wailsto avoid incorrect provenance and potential link drift after merge.🔧 Suggested fix
-<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/events.ts#L29">src/events.ts:29</a></li></ul></aside> +<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/events.ts#L29">src/events.ts:29</a></li></ul></aside>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Clipboard.Text.html-3-3 (1)
3-3: Use the canonical repo in “Defined in” links.Line 3 points to a fork (
AbdelhadiSeddar/wails). For published docs, this should likely referencewailsapp/wailsto avoid broken links and incorrect attribution.🔧 Suggested fix
-<li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/clipboard.ts#L33">src/clipboard.ts:33</a></li> +<li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/clipboard.ts#L33">src/clipboard.ts:33</a></li>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Clipboard.SetText.html-4-4 (1)
4-4: Align the source link with the upstream repo.Line 4 links to the contributor’s fork. For public docs, this should typically point to
wailsapp/wailsto keep links stable and properly attributed.🔧 Suggested fix
-<li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/clipboard.ts#L24">src/clipboard.ts:24</a></li> +<li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/clipboard.ts#L24">src/clipboard.ts:24</a></li>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsARM64.html-3-3 (1)
3-3: Source link points to a contributor fork.Line 3 now references AbdelhadiSeddar/wails. For upstream docs, the “Defined in” link should typically point to the canonical repository (wailsapp/wails). Consider regenerating docs with the correct repo metadata or reverting the link.
🔧 Suggested correction
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L147">src/system.ts:147</a></li></ul></aside></div></li></ul></section></div> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L147">src/system.ts:147</a></li></ul></aside></div></li></ul></section></div>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsARM.html-3-3 (1)
3-3: Source link points to a contributor fork.Line 3 now references AbdelhadiSeddar/wails. For upstream docs, the “Defined in” link should typically point to the canonical repository (wailsapp/wails) to avoid confusing users. Consider regenerating docs with the correct repo metadata or reverting the link.
🔧 Suggested correction
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L138">src/system.ts:138</a></li></ul></aside></div></li></ul></section></div> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L138">src/system.ts:138</a></li></ul></aside></div></li></ul></section></div>v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Call.ByName.html-6-6 (1)
6-6: Use the canonical repo in the source link.The “Defined in” URL points to a fork; for published docs it should reference
wailsapp/wails(or be generated from a canonical repo URL).🔧 Suggested fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L133">src/calls.ts:133</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L133">src/calls.ts:133</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Call.Call.html-9-9 (1)
9-9: Source link should targetwailsapp/wails.These docs look like official output; linking to a personal fork risks broken or misleading source attribution. Prefer the canonical repo (or update the generator config).
🔧 Suggested fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L88">src/calls.ts:88</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L88">src/calls.ts:88</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Call.ByID.html-6-6 (1)
6-6: Point “Defined in” back to the canonical repo.The docs now link to a contributor fork, which can break or misattribute sources. Prefer the canonical
wailsapp/wailsURL (or update the doc generator config so the link stays correct on regen).🔧 Suggested fix
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L145">src/calls.ts:145</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"> +<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/calls.ts#L145">src/calls.ts:145</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings">v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Events.OffAll.html-2-2 (1)
2-2: Regenerate TypeDoc documentation with upstream repository remote configured.The "Defined in" source links throughout the generated documentation reference
github.com/AbdelhadiSeddar/wailsinstead of the canonicalgithub.com/wailsapp/wails. This occurs because TypeDoc constructs GitHub links using the git remote URL, which points to your fork. All 140+ HTML files inv3/internal/runtime/desktop/@wailsio/runtime/docs/are affected.Regenerate the documentation before merging by ensuring your git remote is configured to the upstream repository, or the maintainers can regenerate after merge. The build script already uses the correct branch reference via
--gitRevision v3-alpha.v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/System.IsDebug.html-3-3 (1)
3-3: Point the “Defined in” source link to the canonical repo.Line 3 links to
AbdelhadiSeddar/wails, which is a personal fork and may become stale or misattribute sources. Prefer the upstream canonical repository (e.g.,wailsapp/wails) for published docs.Proposed fix
-<a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L156">src/system.ts:156</a> +<a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/system.ts#L156">src/system.ts:156</a>v3/internal/runtime/desktop/@wailsio/runtime/docs/types/Events.WailsEventCallback.html-2-2 (1)
2-2: Generated TypeDoc documentation contains fork references in 80+ files.The generated HTML documentation in
v3/internal/runtime/desktop/@wailsio/runtime/docs/contains source links pointing to the contributor's fork (https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/...) instead of the upstream repository. After merge, these links will reference the wrong repository.Regenerate the documentation with the correct repository URL configured, or verify if these generated artifacts should be excluded from version control.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/setTransport.html-8-8 (1)
8-8: Source link incorrectly points to contributor's fork instead of upstream repository.The "Defined in" link references
AbdelhadiSeddar/wailsrather than the canonicalwailsapp/wailsrepository. This appears to be an artifact of regenerating documentation from your fork. After merge, this link will point to the wrong repository.Consider regenerating the documentation from the upstream repository, or avoid committing changes to these auto-generated doc files if the source code itself hasn't changed.
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/getTransport.html-2-2 (1)
2-2: Remove auto-generated documentation files or regenerate from upstream repository.The generated HTML documentation contains 83 files with source links pointing to
AbdelhadiSeddar/wailsfork instead of the upstreamwailsapp/wailsrepository. Since these are auto-generated artifacts (created by TypeDoc during the build process), either exclude them from the PR or regenerate them from the correct upstream context.v3/internal/runtime/desktop/@wailsio/runtime/docs/interfaces/System.OSInfo.html-1-1 (1)
1-1: Remove stray numerals in the index list and fix canonical source links.The index shows literal “2/3/4/5” between property links, which will render as text, and the “Defined in” URLs point to a contributor fork rather than the canonical repo. Please clean the generator/template so the list doesn’t emit stray numerals, and ensure the repository URL is set to
wailsapp/wailsbefore regenerating docs.v3/internal/runtime/desktop/@wailsio/runtime/docs/types/Call.CallOptions.html-9-9 (1)
9-9: Regenerate documentation with correct repository URL.The generated documentation contains references to
github.com/AbdelhadiSeddar/wails(a contributor's fork) instead ofgithub.com/wailsapp/wails(the canonical repository) in 80+ HTML files. The "Defined in" source links direct users away from the main repository. Thepackage.jsoncorrectly specifieswailsapp/wails, indicating the documentation was generated from a forked repository.Regenerate the documentation using the TypeDoc build script (
npm run build:docs) to correct these references across all generated files.v3/UNRELEASED_CHANGELOG.md-23-24 (1)
23-24: Fix typos and clarify wording/path in changelog entries.✍️ Suggested edit
-- Updated to use go v1.25 and wails3 instead of go v1.24 and wails in ..docs/getting-started/installation.mdx -- Updated to use of GTK WebKit Dev v4.1 instead v4.0 according to alpha.64 (v4.0 dev is depricated on some latest releases of linux distros) in ..docs/quick-start/installation.mdx +- Updated to use Go v1.25 and wails3 instead of Go v1.24 and wails in docs/src/content/docs/getting-started/installation.mdx +- Updated to use GTK WebKit Dev v4.1 instead of v4.0 per v3.0.0-alpha.64 (v4.0 dev is deprecated on some recent Linux distros) in docs/src/content/docs/quick-start/installation.mdx
🧹 Nitpick comments (2)
v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Browser.OpenURL.html (1)
3-3: Remove unnecessary empty div element.The empty
<div class="tsd-comment tsd-typography"></div>element serves no purpose and appears to be a documentation generation artifact. Consider regenerating the documentation with updated tooling to avoid such artifacts.v3/internal/runtime/desktop/@wailsio/runtime/docs/interfaces/System.OSInfo.html (1)
6-9: Avoid duplicate empty tsd-comment blocks.Each property renders a second empty
<div class="tsd-comment tsd-typography"></div>right after the real comment, which adds unnecessary DOM and whitespace. Consider adjusting the doc template/generator to avoid emitting empty comment blocks.
Comment on lines
+145
to
+151
| sudo apt install build-essential pkg-config libgtk-3-dev libwebkit2gtk-4.1-dev | ||
| ``` | ||
| </TabItem> | ||
|
|
||
| <TabItem label="Fedora"> | ||
| ```bash | ||
| sudo dnf install gcc pkg-config gtk3-devel webkit2gtk4.0-devel | ||
| sudo dnf install gcc pkg-config gtk3-devel webkit2gtk4.1-devel |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
libwebkit2gtk-4.1-dev Ubuntu Debian official package repository
💡 Result:
Ubuntu (official archive / packages.ubuntu.com): libwebkit2gtk-4.1-dev is available in these Ubuntu series: jammy (22.04 LTS), noble (24.04 LTS), plucky (25.04), questing (25.10) (typically in universe, including security/updates pockets). [2][3][4][5]
Debian (official archive / packages.debian.org): libwebkit2gtk-4.1-dev is available in bookworm (oldstable), bookworm-backports, trixie (stable), forky (testing), sid (unstable), and experimental. [1]
🌐 Web query:
webkit2gtk4.1-devel Fedora official package repository
💡 Result:
webkit2gtk4.1-devel is available in Fedora’s official repositories as a subpackage of webkitgtk (development headers/libs for webkit2gtk4.1). [1]
- Fedora Rawhide:
2.51.90-2.fc44 - Fedora 43:
2.50.4-1.fc43(stable),2.50.0-2.fc43(testing) - Fedora 42:
2.50.4-1.fc42 - EPEL 10.2:
2.48.3-1.el10_1 - EPEL 10.1:
2.50.4-2.el10_1[1]
Install:
sudo dnf install webkit2gtk4.1-develSources: [1]
🌐 Web query:
WebKitGTK 4.1 development headers package name Ubuntu 22.04 24.04 Debian 12 13
💡 Result:
- Ubuntu 22.04 (Jammy):
libwebkit2gtk-4.1-dev(packages.ubuntu.com) - Ubuntu 24.04 (Noble):
libwebkit2gtk-4.1-dev(launchpad.net) - Debian 12 (Bookworm):
libwebkit2gtk-4.1-dev(packages.debian.org) - Debian 13 (Trixie):
libwebkit2gtk-4.1-dev(packages.debian.org)
Citations:
- 1: https://packages.ubuntu.com/jammy/libwebkit2gtk-4.1-dev?utm_source=openai
- 2: https://launchpad.net/ubuntu/noble/amd64/libwebkit2gtk-4.1-dev/2.48.1-0ubuntu0.24.04.1?utm_source=openai
- 3: https://packages.debian.org/bookworm/libwebkit2gtk-4.1-dev?utm_source=openai
- 4: https://packages.debian.org/trixie/libwebkit2gtk-4.1-dev?utm_source=openai
🌐 Web query:
webkit2gtk 4.1 devel Fedora 39 40 41 RHEL package
💡 Result:
-
Fedora 40 / 41: install
webkit2gtk4.1-devel(subpackage ofwebkitgtk). [1]- Example:
sudo dnf install webkit2gtk4.1-devel - Provides
pkgconfig(webkit2gtk-4.1)andpkgconfig(webkit2gtk-web-extension-4.1)(via the -devel RPM). [1]
- Example:
-
Fedora 39: there is no
webkit2gtk4.1-devel; Fedora 39 ships the older API aswebkit2gtk4.0-devel. [2] -
RHEL:
webkit2gtk4.1-develis available via EPEL 10 (i.e., for RHEL/CentOS Stream 10 family), aswebkit2gtk4.1-devel. [1][3][4]- If you’re on RHEL 8/9, EPEL 10 packages won’t apply; you’d typically be on the 4.0 API series instead (or need a newer OS / alternative packaging).
Sources: Fedora package pages for webkit2gtk4.1-devel and EPEL builds, plus Fedora 39 webkit2gtk4.0-devel. [1][2][3][4]
🏁 Script executed:
# Check the installation documentation for supported distro versions
fd -t f "installation" docs/ | head -5
cat docs/src/content/docs/quick-start/installation.mdx | head -200Repository: wailsapp/wails
Length of output: 5672
🏁 Script executed:
# Look for any version requirements or distro support matrix
rg -i "fedora.*39|fedora.*40|supported.*version" docs/ -A 2 -B 2Repository: wailsapp/wails
Length of output: 1476
🏁 Script executed:
# Check for system requirements or version constraints in Wails v3 docs
rg "system.*requirement|support.*version|fedora.*version|minimum.*fedora" docs/ -i -A 3Repository: wailsapp/wails
Length of output: 2065
🏁 Script executed:
# Check if there's a troubleshooting or FAQ section addressing Fedora 39
rg "fedora 39|webkit2gtk4.0" docs/ -i -A 2 -B 2Repository: wailsapp/wails
Length of output: 1476
Fedora 39 compatibility issue with WebKitGTK dev package name.
Ubuntu/Debian package names are correct—libwebkit2gtk-4.1-dev is available on jammy (22.04), noble (24.04), bookworm, and trixie.
However, Fedora 39 does not include webkit2gtk4.1-devel; it only provides webkit2gtk4.0-devel. The current Fedora installation command will fail on Fedora 39. Since Wails v3 documentation references "Fedora 39+" support elsewhere (build guides, changelog), either:
- Add version-specific handling to the Fedora tab (39 →
webkit2gtk4.0-devel; 40+ →webkit2gtk4.1-devel), or - Explicitly document a minimum Fedora 40 requirement if 4.0 compatibility is dropped
Fedora 40+ and later correctly ship webkit2gtk4.1-devel.
🤖 Prompt for AI Agents
In `@docs/src/content/docs/quick-start/installation.mdx` around lines 145 - 151,
Update the Fedora TabItem to handle Fedora 39 compatibility: either replace the
single install line under TabItem label="Fedora" with a short note and two
commands (Fedora 39: use webkit2gtk4.0-devel; Fedora 40+: use
webkit2gtk4.1-devel) or explicitly state a minimum requirement of Fedora 40 and
keep the existing command using webkit2gtk4.1-devel; edit the Fedora TabItem
content around the existing sudo dnf install gcc pkg-config gtk3-devel
webkit2gtk4.1-devel line to reflect the chosen approach.
| @@ -1,2 +1,2 @@ | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Hide | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Application.html">Application</a></li><li><a href="Application.Hide.html">Hide</a></li></ul><h1>Function Hide</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="hide" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Hide</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#hide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hides a certain method by calling the HideMethod function.</p> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L21">src/application.ts:21</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L21">src/application.ts:21</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
Contributor
There was a problem hiding this comment.
Source reference points to fork.
Same issue as noted in System.invoke.html — the "Defined in" link points to AbdelhadiSeddar/wails instead of the official wailsapp/wails repository.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Hide.html
at line 2, The "Defined in" source link in the generated docs for
Application.Hide incorrectly points to the fork (AbdelhadiSeddar/wails); update
the TypeDoc/source link configuration or the source reference generation so the
link uses the official repository (wailsapp/wails) for the Application.Hide
entry (and likewise for System.invoke.html), ensuring the anchor points
(src/application.ts:21) remain unchanged while replacing the repository owner in
the URL.
| @@ -1,2 +1,2 @@ | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Quit | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Application.html">Application</a></li><li><a href="Application.Quit.html">Quit</a></li></ul><h1>Function Quit</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="quit" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Quit</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#quit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Calls the QuitMethod to terminate the program.</p> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L35">src/application.ts:35</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L35">src/application.ts:35</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
Contributor
There was a problem hiding this comment.
Source reference points to fork.
Same issue — the "Defined in" link points to AbdelhadiSeddar/wails instead of wailsapp/wails.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Quit.html
at line 2, The generated docs page Application.Quit.html incorrectly links
"Defined in" to the forked repo; update the TypeDoc/source mapping so the source
link for the Application.Quit entry points to the canonical repository
(wailsapp/wails). Locate the doc generation/config (TypeDoc config or the code
that sets the sourceUrlBase) and change the source root or repository URL used
for src/application.ts (the symbol Application.Quit / src/application.ts
reference) to the correct wailsapp/wails repo so all "Defined in" links resolve
to the original repository.
| @@ -1,2 +1,2 @@ | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Show | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Application.html">Application</a></li><li><a href="Application.Show.html">Show</a></li></ul><h1>Function Show</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="show" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Show</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Calls the ShowMethod and returns the result.</p> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L28">src/application.ts:28</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
| </div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/application.ts#L28">src/application.ts:28</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | |||
Contributor
There was a problem hiding this comment.
Source reference points to fork.
Same issue — the "Defined in" link points to AbdelhadiSeddar/wails instead of wailsapp/wails.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Application.Show.html
at line 2, The "Defined in" source link in the generated docs for
Application.Show points to the forked repo (AbdelhadiSeddar/wails); update the
source URL mapping so generated links use the canonical repo (wailsapp/wails).
Locate where source links are produced for docs generation (the TypeDoc/source
template or the config that emits the "Defined in" anchor for Application.Show)
and replace the forked repo base URL with https://github.com/wailsapp/wails
(affecting the generated "Defined in" anchors across functions like
Application.Show). Regenerate the docs so the HTML
(functions/Application.Show.html) contains the corrected repository link.
Comment on lines
1
to
+3
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OpenURL | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Browser.html">Browser</a></li><li><a href="Browser.OpenURL.html">OpenURL</a></li></ul><h1>Function OpenURL</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="openurl" class="tsd-anchor"></a><span class="tsd-kind-call-signature">OpenURL</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="https://developer.mozilla.org/docs/Web/API/URL" class="tsd-signature-type external" target="_blank">URL</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#openurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Open a browser window to the given URL.</p> | ||
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="https://developer.mozilla.org/docs/Web/API/URL" class="tsd-signature-type external" target="_blank">URL</a></span><div class="tsd-comment tsd-typography"><p>The URL to open</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/browser.ts#L22">src/browser.ts:22</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | ||
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/browser.ts#L22">src/browser.ts:22</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -e
echo "=== Verifying the specific file mentioned ==="
if [ -f "v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Browser.OpenURL.html" ]; then
echo "File exists. Checking for fork references..."
grep -o "github.com/[^/]*/wails" "v3/internal/runtime/desktop/@wailsio/runtime/docs/functions/Browser.OpenURL.html" | head -5
else
echo "File not found at specified path"
# Try to find it
find . -name "Browser.OpenURL.html" 2>/dev/null | head -5
fi
echo -e "\n=== Searching for TypeDoc configuration ==="
fd -type f \( -name "typedoc.json" -o -name "typedoc.js" -o -name "typedoc.config.*" \) | head -10
echo -e "\n=== Checking v3 package.json for repository configuration ==="
if [ -f "v3/internal/runtime/desktop/@wailsio/runtime/package.json" ]; then
cat "v3/internal/runtime/desktop/@wailsio/runtime/package.json" | head -30
fi
echo -e "\n=== Counting files with AbdelhadiSeddar/wails references ==="
rg -l "AbdelhadiSeddar/wails" --max-count=1000 | wc -l
echo -e "\n=== Sample files with fork references ==="
rg -l "AbdelhadiSeddar/wails" --max-count=1000 | head -20
echo -e "\n=== Checking for official wailsapp/wails references ==="
rg -l "wailsapp/wails" --max-count=1000 | wc -lRepository: wailsapp/wails
Length of output: 3041
Regenerate documentation files that reference the fork repository.
The HTML documentation files reference AbdelhadiSeddar/wails (contributor's fork) instead of the official wailsapp/wails repository. Affected files: 80 documentation files in v3/internal/runtime/desktop/@wailsio/runtime/docs/. When users click "Defined in" source links, they will be redirected to the fork instead of the official repository.
The package.json repository configuration is correct (pointing to wailsapp/wails), so these files need to be regenerated with TypeDoc to update the source references. The majority of the documentation (1739 files) has the correct official repository references, indicating successful regenerations in other builds.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/functions/Browser.OpenURL.html
around lines 1 - 3, The HTML docs under
v3/internal/runtime/desktop/@wailsio/runtime/docs (e.g., Browser.OpenURL.html)
contain source links pointing to the contributor fork (AbdelhadiSeddar/wails);
regenerate the TypeDoc output so links use the correct repository
(wailsapp/wails) from package.json. Run your TypeDoc generation step for that
package (the same command used for other regenerated docs), verify the "Defined
in" source URLs now point to wailsapp/wails, and commit the regenerated files
(replace the 80 affected files in
v3/internal/runtime/desktop/@wailsio/runtime/docs). Ensure no manual edits to
HTML—rebuild via TypeDoc so the repository metadata in package.json is applied.
Comment on lines
1
to
+7
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CancellablePromiseWithResolvers | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="CancellablePromiseWithResolvers.html">CancellablePromiseWithResolvers</a></li></ul><h1>Interface CancellablePromiseWithResolvers<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Wraps a cancellable promise along with its resolution methods. | ||
| The <code>oncancelled</code> field will be null initially but may be set to provide a custom cancellation function.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CancellablePromiseWithResolvers</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#oncancelled">oncancelled</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_internal_.CancellablePromiseCanceller.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseCanceller</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#promise">promise</a><span class="tsd-signature-symbol">:</span> <a href="../classes/CancellablePromise.html" class="tsd-signature-type tsd-kind-class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#reject">reject</a><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseRejector.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseRejector</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#resolve">resolve</a><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseResolver.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseResolver</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L78">src/cancellable.ts:78</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CancellablePromiseWithResolvers.html#oncancelled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>oncancelled</span></a> | ||
| </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CancellablePromiseWithResolvers</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#oncancelled">oncancelled</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_internal_.CancellablePromiseCanceller.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseCanceller</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#promise">promise</a><span class="tsd-signature-symbol">:</span> <a href="../classes/CancellablePromise.html" class="tsd-signature-type tsd-kind-class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#reject">reject</a><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseRejector.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseRejector</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="CancellablePromiseWithResolvers.html#resolve">resolve</a><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseResolver.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseResolver</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L78">src/cancellable.ts:78</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CancellablePromiseWithResolvers.html#oncancelled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>oncancelled</span></a> | ||
| <a href="CancellablePromiseWithResolvers.html#promise" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>promise</span></a> | ||
| <a href="CancellablePromiseWithResolvers.html#reject" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject</span></a> | ||
| <a href="CancellablePromiseWithResolvers.html#resolve" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resolve</span></a> | ||
| </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="oncancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>oncancelled</span><a href="#oncancelled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">oncancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_internal_.CancellablePromiseCanceller.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseCanceller</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L82">src/cancellable.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="promise" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>promise</span><a href="#promise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">promise</span><span class="tsd-signature-symbol">:</span> <a href="../classes/CancellablePromise.html" class="tsd-signature-type tsd-kind-class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L79">src/cancellable.ts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="reject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reject</span><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseRejector.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseRejector</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L81">src/cancellable.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="resolve" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resolve</span><a href="#resolve" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resolve</span><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseResolver.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseResolver</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L80">src/cancellable.ts:80</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#oncancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>oncancelled</span></a><a href="#promise" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>promise</span></a><a href="#reject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject</span></a><a href="#resolve" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resolve</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | ||
| </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="oncancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>oncancelled</span><a href="#oncancelled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">oncancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_internal_.CancellablePromiseCanceller.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseCanceller</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L82">src/cancellable.ts:82</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="promise" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>promise</span><a href="#promise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">promise</span><span class="tsd-signature-symbol">:</span> <a href="../classes/CancellablePromise.html" class="tsd-signature-type tsd-kind-class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L79">src/cancellable.ts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="reject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">reject</span><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseRejector.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseRejector</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L81">src/cancellable.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="resolve" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resolve</span><a href="#resolve" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resolve</span><span class="tsd-signature-symbol">:</span> <a href="../types/_internal_.CancellablePromiseResolver.html" class="tsd-signature-type tsd-kind-type-alias">CancellablePromiseResolver</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CancellablePromiseWithResolvers.html#t">T</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/cancellable.ts#L80">src/cancellable.ts:80</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#oncancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>oncancelled</span></a><a href="#promise" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>promise</span></a><a href="#reject" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>reject</span></a><a href="#resolve" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resolve</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for the personal fork references in HTML documentation
echo "=== Searching for AbdelhadiSeddar/wails references in HTML files ==="
find . -type f -name "*.html" -path "*/docs/*" -exec grep -l "AbdelhadiSeddar/wails" {} \; | head -20
echo -e "\n=== Checking the specific file mentioned in the review ==="
if [ -f "v3/internal/runtime/desktop/@wailsio/runtime/docs/interfaces/CancellablePromiseWithResolvers.html" ]; then
echo "File exists. Checking for fork references:"
grep -o "github\.com/[^/]*/wails" "v3/internal/runtime/desktop/@wailsio/runtime/docs/interfaces/CancellablePromiseWithResolvers.html" | sort | uniq -c
else
echo "File not found at expected path"
fi
echo -e "\n=== Count of HTML files with fork references ==="
find . -type f -name "*.html" -path "*/docs/*" | xargs grep -l "AbdelhadiSeddar/wails" 2>/dev/null | wc -l
echo -e "\n=== Sample of affected files ==="
find . -type f -name "*.html" -path "*/docs/*" | xargs grep -l "AbdelhadiSeddar/wails" 2>/dev/null | head -5Repository: wailsapp/wails
Length of output: 4657
All generated TypeDoc documentation references personal fork instead of canonical repository.
The HTML documentation files in v3/internal/runtime/desktop/@wailsio/runtime/docs/ contain 80 files with source links pointing to https://github.com/AbdelhadiSeddar/wails/ instead of the canonical repository https://github.com/wailsapp/wails/. When users click "Defined in" links throughout the API documentation, they will be directed to the contributor's personal fork, which may become unavailable or outdated after the PR is merged.
Before merging, ensure the git remote is configured to point to wailsapp/wails and regenerate the TypeDoc documentation so all source links reference the correct repository.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/CancellablePromiseWithResolvers.html
around lines 1 - 7, The generated TypeDoc HTML files under
v3/internal/runtime/desktop/@wailsio/runtime/docs/ contain "Defined in" links
pointing to the personal fork (e.g., links like the one for src/cancellable.ts
shown in CancellablePromiseWithResolvers.html) because the repo remote used
during docs generation is incorrect; fix this by updating the git remote to the
canonical repository (set origin to https://github.com/wailsapp/wails or ensure
`git remote get-url origin` returns that), then regenerate the TypeDoc output
(re-run your TypeDoc/typedoc generation step) so all "Defined in"/source links
in files such as CancellablePromiseWithResolvers.html and other docs reference
the wailsapp/wails repository instead of AbdelhadiSeddar's fork.
| @@ -1,9 +1,9 @@ | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageDialogOptions | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Dialogs.html">Dialogs</a></li><li><a href="Dialogs.MessageDialogOptions.html">MessageDialogOptions</a></li></ul><h1>Interface MessageDialogOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MessageDialogOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#buttons">Buttons</a><span class="tsd-signature-symbol">?:</span> <a href="Dialogs.Button.html" class="tsd-signature-type tsd-kind-interface">Button</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#detached">Detached</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#message">Message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#title">Title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/dialogs.ts#L96">src/dialogs.ts:96</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Dialogs.MessageDialogOptions.html#buttons" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Buttons?</span></a> | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageDialogOptions | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Dialogs.html">Dialogs</a></li><li><a href="Dialogs.MessageDialogOptions.html">MessageDialogOptions</a></li></ul><h1>Interface MessageDialogOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MessageDialogOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#buttons">Buttons</a><span class="tsd-signature-symbol">?:</span> <a href="Dialogs.Button.html" class="tsd-signature-type tsd-kind-interface">Button</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#detached">Detached</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#message">Message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Dialogs.MessageDialogOptions.html#title">Title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/dialogs.ts#L96">src/dialogs.ts:96</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Dialogs.MessageDialogOptions.html#buttons" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Buttons?</span></a> | |||
Contributor
There was a problem hiding this comment.
Source references point to contributor's fork instead of official repository.
All "Defined in" source links in this generated documentation point to https://github.com/AbdelhadiSeddar/wails/... instead of the official https://github.com/wailsapp/wails/... repository. This appears to have happened because TypeDoc was regenerated while the local git remote was configured to your fork.
After this PR is merged, users clicking these links will be directed to your personal fork rather than the official Wails repository. Please regenerate the TypeDoc documentation with the upstream repository configured, or update the TypeDoc configuration to use the correct repository URL.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/Dialogs.MessageDialogOptions.html
at line 1, The generated docs for symbols like MessageDialogOptions show
"Defined in" links pointing at your fork (AbdelhadiSeddar) because TypeDoc was
built with the local git remote set to your fork; fix by regenerating the docs
after configuring the git remote to the official repository (or by setting the
repository/source link in the TypeDoc config to
https://github.com/wailsapp/wails) so the "Defined in" links for
MessageDialogOptions and other symbols point to the upstream repo.
| @@ -1,6 +1,6 @@ | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Info | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/IOS.html">IOS</a></li><li><a href="../modules/IOS.Device.html">Device</a></li><li><a href="IOS.Device.Info.html">Info</a></li></ul><h1>Interface Info</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Info</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-constructor" href="IOS.Device.Info.html#constructor">constructor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#issimulator">isSimulator</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#model">model</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#systemname">systemName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#systemversion">systemVersion</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L33">src/ios.ts:33</a></li><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L27">src/ios.ts:27</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="IOS.Device.Info.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> | |||
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Info | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/IOS.html">IOS</a></li><li><a href="../modules/IOS.Device.html">Device</a></li><li><a href="IOS.Device.Info.html">Info</a></li></ul><h1>Interface Info</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Info</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-constructor" href="IOS.Device.Info.html#constructor">constructor</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#issimulator">isSimulator</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#model">model</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#systemname">systemName</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="IOS.Device.Info.html#systemversion">systemVersion</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L33">src/ios.ts:33</a></li><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/ios.ts#L27">src/ios.ts:27</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="IOS.Device.Info.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> | |||
Contributor
There was a problem hiding this comment.
Critical: Documentation links point to personal fork instead of official repository.
All "Defined in" source links throughout this generated documentation reference https://github.com/AbdelhadiSeddar/wails/ instead of the official https://github.com/wailsapp/wails/ repository. When this PR is merged, these links will direct users to a personal fork rather than the canonical source, causing confusion and potential broken links if the fork is deleted or made private.
This appears to be an artifact of the documentation generation process using the git remote URL from your local fork. The documentation should be regenerated from a context that references the official repository.
🔧 Recommended fix
Regenerate the TypeDoc documentation with the git remote configured to point to the official repository:
# Before regenerating documentation, ensure git remote points to official repo
git remote set-url origin https://github.com/wailsapp/wails.git
# Or configure TypeDoc to use the correct repository URL in its configurationAll instances of https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/ should be https://github.com/wailsapp/wails/blob/v3-alpha/ in the generated documentation.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/IOS.Device.Info.html
at line 1, The generated TypeDoc HTML contains "Defined in" links pointing to
the personal fork URL (AbdelhadiSeddar/wails) instead of the official
wailsapp/wails repo; fix by regenerating the docs after updating the git remote
or TypeDoc config to the canonical repo URL so links like those referencing
src/ios.ts (e.g., the Info interface defined in src/ios.ts) point to
https://github.com/wailsapp/wails/; specifically, set git remote origin to
https://github.com/wailsapp/wails.git (or set the repository option in TypeDoc)
and then re-run the documentation generation so all instances of the fork URL
are replaced with the official repository URL.
| Implement this interface to use WebSockets, custom protocols, or any other | ||
| transport mechanism instead of the default HTTP fetch.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RuntimeTransport</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="RuntimeTransport.html#call-1">call</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">objectID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">method</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">windowName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/runtime.ts#L40">src/runtime.ts:40</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="RuntimeTransport.html#call" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>call</span></a> | ||
| </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RuntimeTransport</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="RuntimeTransport.html#call-1">call</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">objectID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">method</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">windowName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/runtime.ts#L40">src/runtime.ts:40</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="RuntimeTransport.html#call" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>call</span></a> |
Contributor
There was a problem hiding this comment.
Source links point to contributor's fork instead of main repository.
The "Defined in" links reference https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/... instead of the canonical https://github.com/wailsapp/wails/blob/.... After merge, these links will point to a fork that may diverge or become unavailable.
This appears to be a TypeDoc-generated file that was regenerated from your fork's environment. Consider one of:
- Exclude generated documentation files from this PR and let CI regenerate them
- Regenerate the docs with the correct repository configuration pointing to
wailsapp/wails - If these files must be committed, configure TypeDoc's
gitRemoteoption to use the upstream repository
#!/bin/bash
# Check for other generated docs with fork references
rg -l "AbdelhadiSeddar/wails" --glob "*.html" | head -20#!/bin/bash
# Check if there's a TypeDoc config that could be updated
fd -e json -e js "typedoc" --exec cat {}Also applies to: 11-11
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/RuntimeTransport.html
at line 4, The generated TypeDoc HTML includes source links pointing to your
fork (e.g., the "Defined in" link shown on the RuntimeTransport page) because
docs were built from your local fork; remove or regenerate those artifacts:
either (a) revert/remove the generated docs from this PR so CI can produce them,
or (b) rebuild the docs with TypeDoc configured to use the upstream repository
by setting the gitRemote/gitRevision options to "wailsapp/wails" (or correct
repo), and then commit the regenerated files; look for the RuntimeTransport HTML
and the TypeDoc config (typedoc options in your build/typedoc config or
src/runtime.ts reference) to apply the fix.
Comment on lines
+1
to
+9
| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Rect | @wailsio/runtime</title><meta name="description" content="Documentation for @wailsio/runtime"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@wailsio/runtime</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@wailsio/runtime</a></li><li><a href="../modules/Screens.html">Screens</a></li><li><a href="Screens.Rect.html">Rect</a></li></ul><h1>Interface Rect</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Rect</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="Screens.Rect.html#height">Height</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Screens.Rect.html#width">Width</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Screens.Rect.html#x">X</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="Screens.Rect.html#y">Y</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L18">src/screens.ts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Screens.Rect.html#height" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Height</span></a> | ||
| <a href="Screens.Rect.html#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Width</span></a> | ||
| <a href="Screens.Rect.html#x" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>X</span></a> | ||
| <a href="Screens.Rect.html#y" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Y</span></a> | ||
| </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="height" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Height</span><a href="#height" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The height of the rectangle.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L26">src/screens.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="width" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The width of the rectangle.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L24">src/screens.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="x" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>X</span><a href="#x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">X</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The X coordinate of the origin.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L20">src/screens.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="y" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Y</span><a href="#y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Y</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The Y coordinate of the origin.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/wailsapp/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L22">src/screens.ts:22</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#height" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Height</span></a><a href="#width" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Width</span></a><a href="#x" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>X</span></a><a href="#y" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Y</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L26">src/screens.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="width" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Width</span><a href="#width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The width of the rectangle.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L24">src/screens.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="x" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>X</span><a href="#x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">X</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The X coordinate of the origin.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L20">src/screens.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="y" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Y</span><a href="#y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Y</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The Y coordinate of the origin.</p> | ||
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/v3/internal/runtime/desktop/@wailsio/runtime/src/screens.ts#L22">src/screens.ts:22</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#height" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Height</span></a><a href="#width" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Width</span></a><a href="#x" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>X</span></a><a href="#y" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Y</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@wailsio/runtime</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
Contributor
There was a problem hiding this comment.
Source links incorrectly point to contributor's fork instead of upstream repository.
All "Defined in" source references in this generated documentation point to AbdelhadiSeddar/wails (your fork) rather than wailsapp/wails (the upstream repository). For example:
https://github.com/AbdelhadiSeddar/wails/blob/v3-alpha/...
When merged, official documentation would direct users to a fork instead of the main repository. This typically happens when TypeDoc is regenerated from a forked repository without updating the git remote or TypeDoc configuration.
Please regenerate the documentation after ensuring your local repository's origin points to the upstream wailsapp/wails, or configure TypeDoc's gitRemote option appropriately.
🤖 Prompt for AI Agents
In
`@v3/internal/runtime/desktop/`@wailsio/runtime/docs/interfaces/Screens.Rect.html
around lines 1 - 9, The generated docs source links point to your fork
(AbdelhadiSeddar/wails) instead of the upstream repo; fix by updating the
repository remote or TypeDoc config and regenerating the docs: either set your
local git origin to the upstream wailsapp/wails (so TypeDoc picks correct repo)
or set TypeDoc's gitRemote option to "https://github.com/wailsapp/wails" in your
typedoc.json, then re-run the doc generation and verify "Defined in" links
(e.g., the Screens.Rect / src/screens.ts references) now point to wailsapp/wails
before committing.
Author
|
For some reason it changed links towards my fork instead of the official one. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Fixed version numbers according to alpha.64, and use of wails3 instead of wails in some found cases
Type of change
Please select the option that is relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using
wails doctor.If you checked Linux, please specify the distro and version.
Test Configuration
Wails (v3.0.0-alpha.64) Wails Doctor
System
┌───────────────────────────────────────────────────────────────────────────┐
| Name | KDE neon |
| Version | 24.04 |
| ID | neon |
| Branding | User Edition |
| Platform | linux |
| Architecture | amd64 |
| Desktop Environment | KDE |
| NVIDIA Driver | N/A |
| XDG_SESSION_TYPE | wayland |
| CPU | Intel(R) Core(TM) i3-7100 CPU @ 3.90GHz |
| GPU 1 | HD Graphics 630 (Intel Corporation) - Driver: i915 |
| Memory | 7GB |
└───────────────────────────────────────────────────────────────────────────┘
Build Environment
┌────────────────────────────────┐
| Wails CLI | v3.0.0-alpha.64 |
| Go Version | go1.25.6 |
| -buildmode | exe |
| -compiler | gc |
| CGO_CFLAGS | |
| CGO_CPPFLAGS | |
| CGO_CXXFLAGS | |
| CGO_ENABLED | 1 |
| CGO_LDFLAGS | |
| GOAMD64 | v1 |
| GOARCH | amd64 |
| GOOS | linux |
└────────────────────────────────┘
Dependencies
┌────────────────────────────────────────────────────────────────┐
| gcc | 12.10ubuntu1 |
| gtk3 | 3.24.41-4ubuntu1.3 |
| npm | |
| pkg-config | 1.8.1-2build1 |
| webkit2gtk | 2.50.4-0ubuntu0.24.04.1 |
| docker | *Not installed (optional - for cross-compilation) |
| |
└─────────────────── * - Optional Dependency ────────────────────┘
Checking for issues
SUCCESS No issues found
Diagnosis
WARNING There are some items above that need addressing!
Need documentation? Run: wails3 docs
♥ If Wails is useful to you or your company, please consider sponsoring the project: wails3 sponsor
Checklist:
website/src/pages/changelog.mdxwith details of this PRSummary by CodeRabbit
Documentation
wails doctortowails3 doctoracross platform-specific documentation.✏️ Tip: You can customize this high-level summary in your review settings.