Releases: AsyrafHussin/npm-malaysia-postcodes
v2.3.0: New Filter Function & Data Cleanup
What's New
Added
getPostcodesByPrefix
function for easy postcode search.
Fixed
- Removed incorrect-length postcodes.
Removed Postcodes
Kedah
- Alor Setar: 5110, 5330
- Bedong: 8170
- Langkawi: 7520
Perlis
- Kangar: 1750
v2.2.0: Enhanced Code Quality and Additional Test Cases
This update brings multiple enhancements and new features aimed at code quality, performance, and developer experience.
New Features
- New test cases for
findPostcode
,findCities
,getCities
, andgetPostcodes
functions. - Type and null checks for all function parameters have been added for more robust code.
Code Quality
- Introduced Prettier and ESLint for better code formatting and linting.
- Husky pre-commit and pre-push hooks have been updated for better code quality checks.
Improvements
- Test descriptions for
findCities
have been refactored for better readability.
Maintenance
.npmignore
has been added to exclude test and examples folders from the NPM package.
We strongly recommend all users to update to this new version for an improved experience.
v2.1.0: Webpack Configuration Update
This minor release brings a series of important improvements to our Webpack configuration. These changes will not only optimize the build process but also resolve issues related to Server-Side Rendering (SSR).
Changes
- Major Webpack configuration improvements.
- Enhanced build optimization.
- Solved SSR compatibility issues.
We recommend all users update to this version for enhanced performance and compatibility.
v2.0.0: Full TypeScript Migration
🚀 Features:
- Entire codebase now written in TypeScript, offering improved type safety and developer experience.
- Updated build and test configurations to support TypeScript.
🔧 Improvements:
- Enhanced code readability and maintainability with TypeScript typings and interfaces.
- Streamlined build process with relevant TypeScript configurations.
- This release marks a complete shift to TypeScript. While we've done our best to ensure everything runs smoothly, this might introduce subtle differences in behavior due to TypeScript's stricter typing and other nuances. We recommend thorough testing in staging environments before rolling out in production.
📦 Dependency Updates:
- Removed unnecessary Babel dependencies.
- Updated all relevant TypeScript dependencies.
🙏 Acknowledgments:
A big thank you to our community for providing feedback and suggestions. Your continuous support helps in making malaysia-postcodes
better with each release!
v1.8.0: Introducing findCities Function
We're excited to introduce the new findCities
function, allowing you to search for states and postcodes based on city names. In this release, we've also enhanced the findPostcode
function and included an example that showcases how to integrate the library with React Select for a polished user interface. Upgrade to v1.8.0 to leverage these improvements and explore the new example!
v1.7.0 - Automated Publishing and React Example
In this release, we've introduced automated publishing to npm using GitHub Actions and added a new React code example to demonstrate how to use the package in a React application. Check out the updates and improvements:
Automated Publishing: We've set up GitHub Actions to automatically publish the package to npm whenever a new version is released. This streamlines the publishing process and ensures consistent updates.
React Example: We've included a new example showcasing how to integrate Malaysia Postcodes into a React application. The example demonstrates how to create a dynamic address form that selects states, cities, and postcodes based on user input.
Remember to update your project by installing the latest version (1.7.0) and exploring the React example for an enhanced experience.
v1.6.1: Test Enhancements
We're excited to introduce a patch update for the Malaysia Postcodes library, focusing on test enhancements to ensure the utmost reliability of our codebase!
Key Highlights:
Enhanced Testing: In this patch release, we've diligently worked on refining and expanding our test suite. This ensures that every aspect of the Malaysia Postcodes library is thoroughly tested and meets the highest standards of quality.
Your feedback is invaluable to us, and we're dedicated to delivering a dependable and robust library for all your Malaysia postcode-related needs. As always, your support drives our commitment to continuous improvement.
Thank you for being part of the Malaysia Postcodes community!
v1.6.0: Version & CDN Link Automation
We're excited to introduce version 1.6.0 of the Malaysia Postcodes library, packed with new features to enhance your experience!
Key Highlights:
-
Dynamic Version Update:
- Our
package.json
has been enhanced to support automatic version updates. Every time the bundle script is run, the version is updated dynamically.
- Our
-
CDN Link Automation:
- We've introduced
update-cdn-versions.js
, a new automation script. Its primary function is to update CDN links in both the README and example files, ensuring consistency and accuracy.
- We've introduced
Thank you for your continued support and contributions to the Malaysia Postcodes library!
v1.5.1 - Bundle Compilation & README Update
In this release:
- Compiled the latest bundle for version 1.5.1 ensuring stability and performance.
- Updated README to provide
yarn
installation instructions for added clarity and user-friendliness.
We're always striving to make malaysia-postcodes
more accessible and easy to use. Thanks for the support and feedback from the community!
v1.5.0: Enhancements and Refinements
In this release, we've made several notable updates:
- Documentation Updates: Enhanced documentation by adding examples for both ES6 (using Vite) and traditional script-tag methods. Now, users have a clearer guide on how to integrate our module into their projects.
- Refinements: Function logic has been refined for clarity. Comprehensive comments have also been added to each function, enhancing understandability and maintainability of the code.
- Project Structure: For better organization and future scalability, core files were migrated to the 'src' directory. Test paths were also updated to reflect this change.
- Dependency Updates: Updated dependencies for security and improved performance. Specifically, @babel/core was updated to v7.22.11, and jest to v29.6.4.
Your feedback is always welcome! Feel free to raise any issues or feature requests.