\n\nUtility package to get favicons from the web. I don't know why, but it's so damn hard to get favicons *just right*. \nYou may get different sizes, quality, background and other variables that make it a pain to work with.\n\n## Roadmap\n\n- [Usage](#usage)\n- [Favicon](#favicon)\n- [getFavicons](#getfavicons)\n- [getFavicon](#getfavicon)\n- [extractFavicons](#extractfavicons)\n- [getFaviconFrom](#getfaviconfrom)\n- [getFaviconsFrom](#getfaviconsfrom)\n\n## Usage\n\nWarning: this is a library meant to be run on Node.js (server-side). \nFirst, install the package:\n```bash\nnpm install @andresmarpz/favicons\n```\n\n## Favicon\n\nThe Favicon object has the following structure\n```ts\ninterface Favicon {\n url: string;\n size: number; // in bytes\n extension: \"ico\" | \"png\" | \"gif\" | \"jpg\" | \"jpeg\" | \"svg\";\n}\n```\n\n## getFavicons\n\nThis is the most common import, so it's probably what you are looking for.\n\n```ts\nimport { getFavicons } from '@andresmarpz/favicons';\n\n..\nconst favicons = await getFavicons('nextjs.org');\n..\n```\n\n## getFavicon\n\nFunction to return only the biggest favicon from an URL.\n\n```ts\nimport { getFavicon } from '@andresmarpz/favicons';\n\n..\nconst favicon = await getFavicon('nextjs.org');\n..\n```\n\n# extractFavicons\n\nMethod used to extract favicon hrefs from a html string or head element string. Returns a string[] with urls.\n\n```ts\nimport { extractFavicons } from '@andresmarpz/favicons';\n\n..\nconst request = await fetch('nextjs.org');\nconst html = await request.text();\nconst favicons = extractFavicons(html);\n..\n```\n\n# getFaviconFrom\n\nGet the Favicon object from the given URL.\n\n```ts\nimport { getFaviconFrom } from \"favicons\";\n\nconst favicon = await getFaviconFrom(\"https://nextjs.com/favicon.ico\");\n```\n\n# getFaviconsFrom\n\nGet a Favicon[] from a string[] of favicon urls.\n\n```ts\nimport { requestFavicons } from \"favicons\";\n\nconst favicons = await requestFavicons([\"https://nextjs.com/favicon.ico\", \"https://nextjs.com/favicon.png\"]);\n```\n\n\n## Project structure\n\nThis repo uses [turborepo](https://turborepo.org) to manage apps and packages in a monorepo setup.\n\n| Codebase | Description |\n|:----------|:---------------:|\n| [apps/web](apps/web) | Next.js landing |\n| [packages/npm](packages/npm) | npm package |\n| [packages/local](packages/local) | Local testing |\n\n## Running locally\n\n```bash\n$ git clone https://github.com/andresmarpz/favicons.git\n$ cd favicons\n$ npm i\n```\n","readmeFilename":"README.md","homepage":"https://github.com/andresmarpz/favicons#readme","keywords":["ico","icon","icons","favicon","favicons","get","node","url","web","react","javascript","vanilla","package","fetch"],"repository":{"type":"git","url":"git+https://github.com/andresmarpz/favicons.git"},"bugs":{"url":"https://github.com/andresmarpz/favicons/issues","email":"hello@andrs.me"}}
![\"npm](\"https://img.shields.io/npm/v/@andresmarpz/favicons\")
\n \n \n