{"id":18369177,"url":"https://github.com/ideal-postcodes/core-browser-bundled","last_synced_at":"2025-07-17T09:34:58.507Z","repository":{"id":35501535,"uuid":"216798431","full_name":"ideal-postcodes/core-browser-bundled","owner":"ideal-postcodes","description":"JavaScript browser bundles for api.ideal-postcodes.co.uk client","archived":false,"fork":false,"pushed_at":"2023-01-27T07:42:53.000Z","size":5943,"stargazers_count":2,"open_issues_count":19,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-10T12:55:52.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-22T11:35:45.000Z","updated_at":"2023-01-10T07:26:04.000Z","dependencies_parsed_at":"2023-02-15T06:46:54.555Z","dependency_job_id":null,"html_url":"https://github.com/ideal-postcodes/core-browser-bundled","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/ideal-postcodes/core-browser-bundled","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-browser-bundled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-browser-bundled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-browser-bundled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-browser-bundled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideal-postcodes","download_url":"https://codeload.github.com/ideal-postcodes/core-browser-bundled/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-browser-bundled/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265589515,"owners_count":23793547,"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":[],"created_at":"2024-11-05T23:28:39.872Z","updated_at":"2025-07-17T09:34:58.472Z","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/Ideal%20Postcodes%20Browser%20Logo@3x.png\" alt=\"Ideal Postcodes Javascript Client\"\u003e\r\n\u003c/h1\u003e\r\n\r\n\u003e JavaScript browser bundles for api.ideal-postcodes.co.uk client\r\n\r\n![CI](https://github.com/ideal-postcodes/core-browser-bundled/workflows/CI/badge.svg)\r\n![Cross Browser Testing](https://github.com/ideal-postcodes/core-browser-bundled/workflows/Cross%20Browser%20Testing/badge.svg?branch=saucelabs)\r\n\r\n[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-browser-bundled.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-browser-bundled)\r\n[![jscdn](https://badgen.net/jsdelivr/v/npm/@ideal-postcodes/core-browser-bundled)](https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled/dist/)\r\n[![Release](https://github.com/ideal-postcodes/core-browser-bundled/workflows/Release/badge.svg)](https://github.com/ideal-postcodes/core-browser-bundled/actions)\r\n\r\nThis package exports polyfilled, minified copies of `core-browser` in various formats available on npm and various JavaScript cdns. It can be readily [dropped in](#usage) on a page without transpilation of `core-browser`.\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) as your `package.json` dependency.\r\n\r\nBuilds tested against [a suite of modern and legacy, mobile and desktop browsers](https://github.com/ideal-postcodes/supported-browsers).\r\n\r\n## Download\r\n\r\nLatest and pinned versions of each bundle can be downloaded from [jsdelivr.com](https://www.jsdelivr.com).\r\n\r\nWe strongly recommend serving your own versioned copy. If served from jsdelivr.com please attach a version number.\r\n\r\n### Latest Versions\r\n\r\n- [core-browser.umd.min.js@2](https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@2/dist/core-browser.umd.min.js)\r\n- [core-browser.umd.ie11.min.js@2](https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@2/dist/core-browser.umd.ie11.min.js)\r\n- [core-browser.esm.min.js@2](https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@2/dist/core-browser.esm.min.js)\r\n- [core-browser.esm.modern.min.js@2](https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@2/dist/core-browser.esm.modern.min.js)\r\n\r\n### Pinned Versions\r\n\r\n⚠️ It is important you pin your bundle version in production. Pulling directly from latest may introduce backwards breaking changes.\r\n\r\nPlease follow the instructions on [jsdelivr.com/core-browser-bundled](https://www.jsdelivr.com/package/npm/@ideal-postcodes/core-browser-bundled) to pin a specific version in production.\r\n\r\nExample `\u003cscript\u003e` pinned to version `1.4.0`\r\n\r\n```\r\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@1.4.0/dist/core-browser.umd.min.js\"\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- [Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)\r\n- [Core JS API Client Documentation](https://core-interface.ideal-postcodes.dev/)\r\n- [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-browser-bundled)\r\n- [GitHub Repository](https://github.com/ideal-postcodes/core-browser-bundled)\r\n\r\n## Other JavaScript Clients\r\n\r\n- [Browser Client Repository](https://github.com/ideal-postcodes/core-browser)\r\n- [Node.js Client Repository](https://github.com/ideal-postcodes/core-node)\r\n\r\n## Documentation\r\n\r\n### Bundles Overview\r\n\r\n`core-browser-bundled` ships 4 javascript bundles.\r\n\r\n#### core-browser.umd.min.js\r\n\r\n- **UMD compatible**\r\n- Transpiles core-browser to target browsers with more than 0.25% marketshare according to [caniuse.com](https://caniuse.com/usage-table). This is a moving target and obselete browsers will lose support over time as new builds are created.\r\n- Bundled with `fetch` polyfill\r\n- Default export of the npm module\r\n\r\n#### core-browser.umd.ie11.min.js\r\n\r\n- **UMD compatible**\r\n- Transpiles core-browser to target IE11 as minimum browser version. This will create a fixed target bundle over time. The tradeoff to this is larger script payload.\r\n- Bundled with `fetch` polyfill\r\n\r\n#### core-browser.esm.min.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#### core-browser.esm.latest.min.js\r\n\r\n- **ES Module compatible**\r\n- No legacy browser transpilation or polyfills\r\n- Smallest package size (v1.1.0: 3.5kb gzipped)\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/core-browser-bundled@2/dist/core-browser.umd.min.js\"\u003e\u003c/script\u003e\r\n\r\n\u003cscript\u003e\r\n  var Client = IdealPostcodes.Client;\r\n  var lookupPostcode = IdealPostcodes.lookupPostcode;\r\n  var client = new Client({ api_key: \"iddqd\" });\r\n  var postcode = \"ID1 1QD\";\r\n  lookupPostcode({ postcode, client }).then(function (result) {\r\n    console.log(result);\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/core-browser-bundled@2/dist/core-browser.esm.min.js\"\r\n\u003e\u003c/script\u003e\r\n\r\n\u003cscript type=\"module\"\u003e\r\n  import {\r\n    Client,\r\n    lookupPostcode,\r\n  } from \"https://cdn.jsdelivr.net/npm/@ideal-postcodes/core-browser-bundled@2/dist/core-browser.esm.min.js\";\r\n  const client = new Client({ api_key: \"iddqd\" });\r\n  const postcode = \"ID1 1QD\";\r\n  const result = await lookupPostcode({ postcode, client });\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/core-browser`](https://github.com/ideal-postcodes/core-browser). You can find the quickstart [here](https://github.com/ideal-postcodes/core-browser#quickstart).\r\n\r\nFor a complete list of client methods, including low level resource methods, please see the [core-interface documentation](https://core-interface.ideal-postcodes.dev/#documentation)\r\n\r\n## Build\r\n\r\n```bash\r\nnpm run build\r\n```\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\r\n## Licence\r\n\r\nMIT\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Fcore-browser-bundled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideal-postcodes%2Fcore-browser-bundled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Fcore-browser-bundled/lists"}