Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No Documentation of Options #19

Closed
anudeike opened this issue Nov 3, 2019 · 3 comments
Closed

No Documentation of Options #19

anudeike opened this issue Nov 3, 2019 · 3 comments

Comments

@anudeike
Copy link

anudeike commented Nov 3, 2019

Hi Creators,

This app is extremely helpful and works really well. But I am having trouble finding documentation on how I can specify the number of colors I want in my palette.

Can you point me in the direction in the documentation if there is one? If there isn't can y'all write up one?

Thanks.

@ijambro
Copy link
Contributor

ijambro commented Mar 24, 2020

I don't think there is a way for the caller of this module to specify the number of colors in the palette. The value of 5 is hard-coded, and can only be changed in your local version under node_modules/get-image-colors/index.js.

I would also like to see this added as a new feature, so the caller of this module can specify this number as a parameter. Would others agree?

Currently the "options" parameter is interpreted as either the callback function, or the file type that gets passed in to get-pixels.

@ijambro
Copy link
Contributor

ijambro commented Apr 22, 2020

When I responded last month, I had overlooked the ability to pass an object as the "options" parameter. It is actually easy to specify the number of colors you want in your palette.

I submitted a Pull Request to add this to the Readme:
#20

@zeke
Copy link
Member

zeke commented May 3, 2020

Sorry for the late reply. This was resolved by #20 which landed in 2.0.1

@zeke zeke closed this as completed May 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants