{"id":19888050,"url":"https://github.com/fast-average-color/fast-average-color-node","last_synced_at":"2025-06-17T10:42:27.801Z","repository":{"id":37608627,"uuid":"305983330","full_name":"fast-average-color/fast-average-color-node","owner":"fast-average-color","description":"🍏🍊🍅 A simple library that calculates the average color of any images for Node.js","archived":false,"fork":false,"pushed_at":"2025-03-20T07:43:18.000Z","size":647,"stargazers_count":86,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T16:17:22.866Z","etag":null,"topics":["average-color","color","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fast-average-color.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":"2020-10-21T10:07:46.000Z","updated_at":"2025-03-20T07:43:21.000Z","dependencies_parsed_at":"2025-01-15T14:18:03.229Z","dependency_job_id":"6fa6a38d-d850-435b-95a7-284c4661b5ce","html_url":"https://github.com/fast-average-color/fast-average-color-node","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fast-average-color%2Ffast-average-color-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fast-average-color%2Ffast-average-color-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fast-average-color%2Ffast-average-color-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fast-average-color%2Ffast-average-color-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fast-average-color","download_url":"https://codeload.github.com/fast-average-color/fast-average-color-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247713258,"owners_count":20983683,"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":["average-color","color","nodejs"],"created_at":"2024-11-12T18:06:10.912Z","updated_at":"2025-04-07T19:14:55.302Z","avatar_url":"https://github.com/fast-average-color.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🍏🍊🍅 [Fast Average Color](https://github.com/fast-average-color/fast-average-color/) for Node.js\n[![NPM version](https://img.shields.io/npm/v/fast-average-color-node.svg)](https://www.npmjs.com/package/fast-average-color-node)\n[![NPM Downloads](https://img.shields.io/npm/dm/fast-average-color-node.svg?style=flat)](https://www.npmjs.org/package/fast-average-color-node)\n[![install size](https://packagephobia.com/badge?p=fast-average-color-node)](https://packagephobia.com/result?p=fast-average-color-node)\n\nA simple library that calculates the average color of any images for Node.js.\n\n## Supported formats:\n- `jpeg`\n- `png`\n- `webp`\n- `gif`\n- `svg`\n\n## Source\n- filename\n- url\n- Buffer\n- base64 string\n\n## Install\n`npm i --save fast-average-color-node`\n\n## Using\n```js\nimport { getAverageColor } from 'fast-average-color-node';\n\ngetAverageColor('./image.png').then(color =\u003e {\n    console.log(color);\n});\n```\nor\n```js\nimport { getAverageColor } from 'fast-average-color-node';\n\nasync function printAverageColor() {\n    const color = await getAverageColor('./image.png');\n    console.log(color);\n};\n\nprintAverageColor();\n```\n\n## API\n### `getAverageColor(filename, options)`\n\n#### Parameters\n```js\n/**\n * @param {string | Buffer} [filename] filename, url, Buffer or data64 string\n * @param {Object} [options]\n * @param {number[]}  [options.defaultColor=[0, 0, 0, 0]]\n * @param {number[]}  [options.ignoredColor] [red (0-255), green (0-255), blue (0-255), alpha (0-255)]\n * @param {string} [options.mode=\"speed\"] \"precision\" or \"speed\"\n * @param {string} [options.algorithm=\"sqrt\"] \"simple\", \"sqrt\" or \"dominant\"\n * @param {number} [options.step=1]\n * @param {number} [options.left=0]\n * @param {number} [options.top=0]\n * @param {number} [options.width=width of resource]\n * @param {number} [options.height=height of resource]\n * @param {boolean} [options.silent] Disable error output via console.error\n */\n```\n\n### Return value\nThe promise with value.\n\n```js\n/**\n * @param {Object} [color]\n * @param {string} [color.rgb]\n * @param {string} [color.rgba]\n * @param {string} [color.hex]\n * @param {string} [color.hexa]\n * @param {boolean} [color.isDark]\n * @param {boolean} [color.isLight]\n * @param {number[]} [color.value]\n * @param {Error} [color.error]\n */\n```\n\n## [License](LICENSE)\nMIT License\n\n## Links\n- [fast-average-color](https://github.com/fast-average-color/fast-average-color/)\n\n## Friends\n- [Check device online](https://checkdevice.online/?from=github-fac-node)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffast-average-color%2Ffast-average-color-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffast-average-color%2Ffast-average-color-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffast-average-color%2Ffast-average-color-node/lists"}