Skip to content

docs(state): Deprecate state, state listener, and global state listener #129

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 15, 2025
Merged

docs(state): Deprecate state, state listener, and global state listener #129

merged 1 commit into from
Sep 15, 2025

Conversation

harrytmthy
Copy link
Owner

Summary

  • Marked SafeBoxState, SafeBoxStateListener, and SafeBoxGlobalStateObserver as @Deprecated with clear KDoc explaining why and removal target (v1.4).
  • Kept behavior unchanged in 1.3.x (no runtime changes).
  • Updated inline docs to recommend relying on SharedPreferences listener patterns and not on SafeBox-specific state.

Closes #125

@harrytmthy harrytmthy added this to the 1.3.0 milestone Sep 15, 2025
@harrytmthy harrytmthy self-assigned this Sep 15, 2025
@harrytmthy harrytmthy added the documentation Improvements or additions to documentation label Sep 15, 2025
@harrytmthy harrytmthy enabled auto-merge (squash) September 15, 2025 16:21
@harrytmthy harrytmthy merged commit 6da980e into main Sep 15, 2025
3 checks passed
@harrytmthy harrytmthy deleted the docs/deprecate-state-listener branch September 15, 2025 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@harrytmthy harrytmthy

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
1.3.0
Development

Successfully merging this pull request may close these issues.

Deprecate SafeBoxState and listeners
1 participant
@harrytmthy