颜色提取器技术文档

1. 安装指南

安装colour-extractor如同其他Node.js模块一样简单：

$ npm install @colour-extractor/colour-extractor

注意：此模块包含原生Rust库。如果你的平台不受支持，请打开一个issue。

2. 使用说明

colour-extractor导出了两个函数，用于从照片中提取颜色样板。

topColours 函数

此函数需要一个指向图像的路径（请参见下文支持的格式），并解析为一个包含每个突出颜色的RGB三元的数组。

const { topColours } = require('@colour-extractor/colour-extractor');
const colours = await topColours('./photos/cats/tigre.jpg');
console.log(colours);
// 输出: [ [46, 70, 118], [0, 0, 2], [12, 44, 11] ]

topColoursHex 函数

另一个函数topColoursHex则返回包含#的十六进制代码。

const { topColoursHex } = require('@colour-extractor/colour-extractor');
const hexColours = await topColoursHex('./photos/cats/tigre.jpg');
console.log(hexColours);
// 输出: ["#2e4676", "#000002", "#0c2c0b"]

3. 项目API使用文档

目前项目提供了以下API：

• topColours(imagePath, [sort]): 返回图像中主要颜色的RGB数组。可选的sort参数可以指定是否按频率对颜色进行排序。
• topColoursHex(imagePath, [sort]): 与topColours类似，但返回十六进制颜色代码。

4. 项目安装方式

项目安装方式如下：

• 使用npm进行安装：

  $ npm install @colour-extractor/colour-extractor
  

• 确保你的平台支持原生Rust库，否则可能需要编译或查找预编译的二进制文件。

以上就是关于colour-extractor项目的技术文档，通过此文档，用户可以了解到如何安装、使用以及如何通过API调用实现颜色提取的相关操作。