{"id":18369172,"url":"https://github.com/ideal-postcodes/address-finder-bundled","last_synced_at":"2025-08-01T23:39:43.586Z","repository":{"id":37953840,"uuid":"326596177","full_name":"ideal-postcodes/address-finder-bundled","owner":"ideal-postcodes","description":"JavaScript browser bundles for Address Finder library","archived":false,"fork":false,"pushed_at":"2024-11-05T10:39:40.000Z","size":4111,"stargazers_count":2,"open_issues_count":13,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-15T22:09:24.604Z","etag":null,"topics":["address-finder"],"latest_commit_sha":null,"homepage":"https://ideal-postcodes.co.uk/address-finder","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ideal-postcodes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-04T06:55:13.000Z","updated_at":"2024-11-05T10:39:41.000Z","dependencies_parsed_at":"2024-08-21T13:54:15.639Z","dependency_job_id":"eb7ccd3b-e597-47d9-a1b0-6940c5af456f","html_url":"https://github.com/ideal-postcodes/address-finder-bundled","commit_stats":{"total_commits":265,"total_committers":7,"mean_commits":"37.857142857142854","dds":0.6075471698113207,"last_synced_commit":"25aec62a57e93defa644c9d06ca2a76e49a164bf"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Faddress-finder-bundled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Faddress-finder-bundled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Faddress-finder-bundled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Faddress-finder-bundled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideal-postcodes","download_url":"https://codeload.github.com/ideal-postcodes/address-finder-bundled/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247522454,"owners_count":20952555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address-finder"],"created_at":"2024-11-05T23:28:39.172Z","updated_at":"2025-04-06T17:31:57.942Z","avatar_url":"https://github.com/ideal-postcodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\r\n  \u003cimg src=\"https://img.ideal-postcodes.co.uk/Address%20Finder%20Logo@3x.png\" alt=\"Ideal Postcodes Address Finder Bundle\"\u003e\r\n\u003c/h1\u003e\r\n\r\n\u003e JavaScript browser bundles for the Address Finder library\r\n\r\n![CI](https://github.com/ideal-postcodes/address-finder-bundled/workflows/CI/badge.svg)\r\n![Cross Browser Testing](https://github.com/ideal-postcodes/address-finder-bundled/workflows/Cross%20Browser%20Testing/badge.svg)\r\n![Release](https://github.com/ideal-postcodes/address-finder-bundled/workflows/Release/badge.svg)\r\n\r\n[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder-bundled.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder-bundled)\r\n[![jscdn](https://badgen.net/jsdelivr/v/npm/@ideal-postcodes/address-finder-bundled)](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/)\r\n[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@ideal-postcodes/address-finder-bundled)](https://bundlephobia.com/result?p=@ideal-postcodes/address-finder-bundled)\r\n\r\nThis package exports polyfilled, minified copies of `address-finder` in various formats available on npm and various JavaScript CDNs. It can be readily [dropped in](#usage) on a page without transpilation of `address-finder`.\r\n\r\nIf you intend to incorporate the browser client in your own bundle, please use [`core-browser`](https://github.com/ideal-postcodes/core-browser) in your `package.json`.\r\n\r\n## Download\r\n\r\n### Download Latest Bundle\r\n\r\n- [address-finder.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/address-finder.js)\r\n\r\nServing your own versioned copy is recommended. If a JavaScript CDN is used (e.g. jsDelivr, cdnjs), be sure to pin the version.\r\n\r\nUse [address-finder.esm.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/address-finder.esm.js) if you need a ES Module compatible build.\r\n\r\n### ⚠️ Pinning Versions\r\n\r\nIt is important you pin your bundle version in production. Pulling directly from latest **will** cause your integration to fail at some point in the future.\r\n\r\nFor instance, follow the instructions on [jsdelivr.com/address-finder-bundled](https://www.jsdelivr.com/package/npm/@ideal-postcodes/address-finder-bundled) to pin a major version in production.  E.g.\r\n\r\n```html\r\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4\"\u003e\u003c/script\u003e\r\n```\r\n\r\n## Links\r\n\r\n- [Bundles Overview](#bundles-overview)\r\n- [Usage](#usage)\r\n- [Documentation](https://address-finder.ideal-postcodes.dev/)\r\n- [npm](https://www.npmjs.com/package/@ideal-postcodes/address-finder-bundled)\r\n- [GitHub Repository](https://github.com/ideal-postcodes/address-finder-bundled)\r\n\r\n## Documentation\r\n\r\n### Bundles Overview\r\n\r\n#### address-finder.js\r\n\r\n- **UMD compatible**\r\n- Transpiles address-finder to target Internet Explorer 11 as minimum browser version\r\n- Default export of the npm module\r\n\r\n#### address-finder.esm.js\r\n\r\n- **ES Module compatible**\r\n- Targets browsers with [ES Module support](https://caniuse.com/#search=module)\r\n- Default ES Module export\r\n\r\n### Usage\r\n\r\n#### UMD\r\n\r\n```html\r\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4\"\u003e\u003c/script\u003e\r\n\r\n\u003cscript\u003e\r\n  IdealPostcodes.AddressFinder.setup({\r\n    apiKey: \"ak_test\",\r\n    inputField: \"#line_1\",\r\n    outputFields: {\r\n      line_1: \"#line_1\",\r\n      line_2: \"#line_2\",\r\n      line_3: \"#line_3\",\r\n      post_town: \"#post_town\",\r\n      postcode: \"#postcode\",\r\n    },\r\n  });\r\n\u003c/script\u003e\r\n```\r\n\r\n#### ES Module\r\n\r\n```html\r\n\u003cscript\r\n  type=\"module\"\r\n  src=\"https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4/dist/address-finder.esm.js\"\u003e\u003c/script\u003e\r\n\r\n\u003cscript type=\"module\"\u003e\r\n  import { AddressFinder } from \"https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@2/dist/address-finder.esm.js\";\r\n  AddressFinder.setup({\r\n    apiKey: \"ak_test\",\r\n    inputField: \"#line_1\",\r\n    outputFields: {\r\n      line_1: \"#line_1\",\r\n      line_2: \"#line_2\",\r\n      line_3: \"#line_3\",\r\n      post_town: \"#post_town\",\r\n      postcode: \"#postcode\",\r\n    },\r\n  });\r\n\u003c/script\u003e\r\n```\r\n\r\n### Client Documentation\r\n\r\nThis package is a transpiled copy of [`ideal-postcodes/address-finder`](https://www.npmjs.com/package/@ideal-postcodes/address-finder).\r\n\r\nFor a complete list of client methods, including low level resource methods, please see the [address-finder documentation](https://address-finder.ideal-postcodes.dev/#documentation)\r\n\r\n## Run Examples\r\n\r\nBuild, and serve example pages locally:\r\n\r\n```bash\r\nnpm run build \u0026\u0026 \\ # Build JS bundles\r\nnpm start          # Start http server\r\n```\r\n\r\nFor UMD demo visit [http://localhost:8081/example/umd.html](http://localhost:8081/example/umd.html)\r\n\r\nFor ES module demo visit [http://localhost:8081/example/esm.html](http://localhost:8081/example/esm.html)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Faddress-finder-bundled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideal-postcodes%2Faddress-finder-bundled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Faddress-finder-bundled/lists"}