feat!: consolidate API to VersionCheck object with consistent options#3
Merged
AlshehriAli0 merged 4 commits intomainfrom Mar 5, 2026
Merged
feat!: consolidate API to VersionCheck object with consistent options#3AlshehriAli0 merged 4 commits intomainfrom
AlshehriAli0 merged 4 commits intomainfrom
Conversation
BREAKING CHANGE: All standalone function exports removed. Use VersionCheck object.
- API consolidation: getCountry, getStoreUrl, getLatestVersion, needsUpdate now VersionCheck methods
- Consistent options: all async methods use object-based parameters { countryCode?, level? }
- compareVersions now part of VersionCheck object
- Country code support: optional region override for store lookups (iOS)
- Made getStoreUrl async for consistency
- 52 comprehensive tests with 87%+ coverage (exceeds 70% thresholds)
- Jest setup with TypeScript support, test files excluded from build
- GitHub Actions CI with coverage enforcement and codecov upload
- Updated iOS/Android native implementations with country code parameter
- All documentation updated (api-reference, migration-guide, usage-examples)
Migration: getCountry() → VersionCheck.getCountry()
getLatestVersion() → VersionCheck.getLatestVersion({ countryCode: 'US' })
compareVersions() → VersionCheck.compareVersions('1.0.0', '2.0.0')
Owner
Author
|
closes #1 |
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.
Summary
Test Coverage
Documentation
Breaking Changes
All standalone function exports removed. Migration: