Skip to content

fix(app): correct removeDataStore return type, add docs for getBundle…#14038

Merged
lucasfernog merged 3 commits intotauri-apps:devfrom
KushalMeghani1644:fix/app-api-docs-and-types
Aug 19, 2025
Merged

fix(app): correct removeDataStore return type, add docs for getBundle…#14038
lucasfernog merged 3 commits intotauri-apps:devfrom
KushalMeghani1644:fix/app-api-docs-and-types

Conversation

@KushalMeghani1644
Copy link
Contributor

Summary

This PR makes small improvements to the @tauri-apps/api/app module:

  • Improved documentation: Added JSDoc for getBundleType (with example and @since tag).
  • Type safety: Restored the correct generic for invoke in defaultWindowIcon to ensure proper type inference.
  • Consistency: Added example usage for setDockVisibility and clarified DataStoreIdentifier description.

Motivation

These changes improve correctness, developer experience, and consistency across the API surface.
The fixes are non-breaking and align with existing patterns in the codebase.

Checklist

  • Corrected removeDataStore return type
  • Added missing JSDoc for getBundleType
  • Fixed type error in defaultWindowIcon
  • Improved consistency in documentation and examples

@KushalMeghani1644 KushalMeghani1644 requested a review from a team as a code owner August 19, 2025 09:29
@github-project-automation github-project-automation bot moved this to 📬Proposal in Roadmap Aug 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Aug 19, 2025

Package Changes Through a726398

There are 2 changes which include tauri with patch, @tauri-apps/cli with patch

Planned Package Versions

The following package releases are the planned based on the context of changes in this pull request.

package current next
tauri 2.8.1 2.8.2
@tauri-apps/cli 2.8.0 2.8.1

Add another change file through the GitHub UI by following this link.


Read about change files or the docs at github.com/jbolda/covector

@lucasfernog lucasfernog merged commit f0172a4 into tauri-apps:dev Aug 19, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from 📬Proposal to 🔎 In audit in Roadmap Aug 19, 2025
@Legend-Master
Copy link
Contributor

Legend-Master commented Aug 19, 2025

@lucasfernog It's probably too late, but the package that needs the bump is @tauri-apps/api not @tauri-apps/cli

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

Labels

None yet

Projects

Status: 🔎 In audit

Development

Successfully merging this pull request may close these issues.

3 participants