css-color-parser-h 2.0.3 → 2.0.4

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "css-color-parser-h",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "A tool for parsing css color",
   "main": "dist/css-color-parser-h.common.js",
-  "types": "@types/css-color-parser-h.d.ts",
+  "types": "@types/index.d.ts",
   "scripts": {
-    "build": "webpack && node release.js"
+    "build": "webpack && node release.js",
+    "test": "npm run build && jest",
+    "test-c": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -35,8 +37,8 @@
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "babel-loader": "^9.1.2",
-    "clean-webpack-plugin": "^4.0.0",
     "fs-extra": "^11.1.0",
+    "jest": "^29.5.0",
     "ts-loader": "^9.4.1",
     "tslib": "^2.5.2",
     "typescript": "^4.9.3",

package/readme.md

@@ -40,7 +40,53 @@ Parser.fromColorStr('#4c90f0cc')
 /**
  * 方法总览
  * */
-// Parser的函数
+// CssColorParser类
+// 实例方法
+import { CssColorParser } from 'css-color-parser-h'
+const colorParser = new CssColorParser()
+// 设置输出值的精度
+colorParser.setOutPrecision(colorPrecision: number, outAlphaPrecision: number): CssColorParser;
+colorParser.setColor(red?: number | string,green?: number | string,blue?: number | string,alpha?: number | string): CssColorParser
+colorParser.setAlpha(alpha?: number | string): CssColorParser
+colorParser.setRed(red?: number | string): CssColorParser;
+colorParser.setGreen(green?: number | string): CssColorParser;
+colorParser.setBlue(blue?: number | string): CssColorParser;
+// 设置反色
+colorParser.setInvert(): CssColorParser;
+colorParser.toRGBA(): string
+colorParser.toHEX(): string
+// 获取反色的值（输出一个新的实例）
+colorParser.toInvert(): CssColorParser;
+colorParser.toString(): string
+colorParser.toNormalize(): ColorJson
+colorParser.toArray(): number[]
+colorParser.toJson(): ColorJson
+// 颜色相加
+colorParser.add(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+// 颜色相减
+colorParser.subtract(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+// 颜色相乘
+colorParser.multiply(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+// 颜色相除
+colorParser.divide(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+// 颜色乘以一个数值
+colorParser.multiplyByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser;
+// 颜色除以一个数值
+colorParser.divideByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser;
+// 颜色RGB属性加上一个数值
+colorParser.addNumberForRGB(num: number): CssColorParser;
+// 颜色透明度属性加上一个数值
+colorParser.addNumberForAlpha(num: number): CssColorParser;
+colorParser.clone():CssColorParser
+colorParser.equals(color: CssColorParser):boolean
+// 静态方法
+CssColorParser.parseHEX(v: string): CssColorParser
+CssColorParser.parseRGBA(v: string): CssColorParser
+CssColorParser.fromJson(json: ColorJson): CssColorParser
+CssColorParser.fromArray(color: Array<number>): CssColorParser
+CssColorParser.fromRandomfromRandom(color1: CssColorParser, color2: CssColorParser): CssColorParser
+CssColorParser.fromNormalize(colorArr: [number, number, number, number]): CssColorParser;
+// Parser中的其他函数
 import Parser from 'css-color-parser-h'
 Parser.parseKeyWord(v: string): CssColorParser
 Parser.parseHEX(v: string): CssColorParser
@@ -53,29 +99,21 @@ Parser.fromHWB(h: number, w: number, b: number, a?: number)
 Parser.fromRandom(color1: string | CssColorParser,color2: string | CssColorParser): CssColorParser
 Parser.fromJson(json: ColorJson): CssColorParser
 Parser.fromArray(color: Array<number>): CssColorParser
-// 实例方法
-import { CssColorParser } from 'css-color-parser-h'
-const parser = new CssColorParser()
-parser.setColor(red?: number | string,green?: number | string,blue?: number | string,alpha?: number | string)
-parser.toRGBA(): string
-parser.toHEX(): string
-parser.toString(): string
-parser.toNormalize(): ColorJson
-parser.toArray(): number[]
-parser.toJson(): ColorJson
-parser.clone():CssColorParser
-parser.equals(color):boolean
-// CssColorParser的静态函数
-CssColorParser.parseHEX(v: string): CssColorParser
-CssColorParser.parseRGBA(v: string): CssColorParser
-CssColorParser.fromJson(json: ColorJson): CssColorParser
-CssColorParser.fromArray(color: Array<number>): CssColorParser
-CssColorParser.fromRandomfromRandom(color1: CssColorParser, color2: CssColorParser): CssColorParser
 ```
 
 ## Example
 
 ```js
+import { CssColorParser } from 'css-color-parser-h'
+
+const colorParser = new CssColorParser(255,255,255,1)
+colorParser.toHEX()
+CssColorParser.parseHEX('#FFF')
+CssColorParser.parseRGBA('rgba(255,255,255,1)')
+CssColorParser.fromJson({r: 255, g: 255, b: 255, a: 1})
+CssColorParser.fromArray([255,255,255,1])
+CssColorParser.fromRandom(new CssColorParser(0,0,0,0), new CssColorParser(255,255,255,1))
+
 import Parser from 'css-color-parser-h'
 
 Parser.fromColorStr('blue') // CssColorParser { r: 0, g: 0, b: 255, a: 1 }
@@ -100,13 +138,4 @@ Parser.fromRandom(Parser.fromArray([205,205,100,0.5]), '#ccffbbaa').toRGBA() //
 
 // 归一化
 Parser.fromArray([100, 200, 0, 0.552]).toNormalize() // { r: 0.39, g: 0.78, b: 0, a: 0.55 }
-
-import { CssColorParser } from 'css-color-parser-h'
-
-CssColorParser.parseHEX('#FFF')
-CssColorParser.parseRGBA('rgba(255,255,255,1)')
-CssColorParser.fromJson({r: 255, g: 255, b: 255, a: 1})
-CssColorParser.fromArray([255,255,255,1])
-CssColorParser.fromRandom(new CssColorParser(0,0,0,0), new CssColorParser(255,255,255,1))
-
 ```

package/@types/css-color-parser-h.d.ts

@@ -1,230 +0,0 @@
-/*
- * @Author: roman_123
- * @Description:
- * @Date: 2023-05-26 13:29:45
- * @LastEditTime: 2023-05-26 16:10:51
- */
-export class ColorJson {
-  r: number
-  g: number
-  b: number
-  a: number
-}
-declare module 'css-color-parser-h' {
-  /**
-   * @description: 解析颜色关键字
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseKeyWord('red')
-   */
-  export function parseKeyWord(v: string): CssColorParser
-  /**
-   * @description: 解析16进制字符串
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseHEX('#FFF')
-   */
-  export function parseHEX(v: string): CssColorParser
-  /**
-   * @description: 解析RGBA
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseRGBA('rgba(255,255,255,1)')
-   */
-  export function parseRGBA(v: string): CssColorParser
-  /**
-   * @description: 解析HSLA
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseHSLA('hsla(215,85%,62%,0.8)')
-   */
-  export function parseHSLA(v: string): CssColorParser
-  /**
-   * @description: 解析HWB
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseHWB('hwb(215deg 30% 6% / 80%)')
-   */
-  export function parseHWB(v: string): CssColorParser
-  /**
-   * @description: 将css字符串转换为解析对象
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: parseCssColorStr('rgba(255,255,255,1)')
-   */
-  export function parseCssColorStr(v: string): CssColorParser
-  /**
-   * **Deprecated method.** Use `parseCssColorStr()` instead.
-   * @description: since 2.0.1
-   * @deprecated
-   * @param {string} v
-   * @return {CssColorParser}
-   * @example: fromColorStr('rgba(255,255,255,1)')
-   */
-  export function fromColorStr(v: string): CssColorParser
-  /**
-   * @description: 将HSL色彩模式转换为解析对象
-   * @param {number} hue 色相
-   * @param {number} saturation 饱和度
-   * @param {number} lightness 亮度
-   * @param {number} alpha 不透明度
-   * @return {CssColorParser}
-   * @example: fromHSL(0,1,1,1)
-   */
-  export function fromHSL(
-    h: number,
-    s: number,
-    l: number,
-    a?: number
-  ): CssColorParser
-  /**
-   * @description: 将HWB色彩模式转换为解析对象
-   * @param {number} h 色调
-   * @param {number} w 白度
-   * @param {number} b 黑度
-   * @param {number} a 不透明度
-   * @return {CssColorParser}
-   * @example: fromHSL(0,1,1,1)
-   */
-  export function fromHWB(
-    h: number,
-    w: number,
-    b: number,
-    a?: number
-  ): CssColorParser
-  /**
-   * @description: 产生随机颜色
-   * @return {CssColorParser}
-   * @example: fromRandom('#000', ''#fff)
-   */
-  export function fromRandom(
-    color1: string | CssColorParser,
-    color2: string | CssColorParser
-  ): CssColorParser
-  /**
-   * @description: 将ColorJson格式的json数据转换为解析对象
-   * @param {ColorJson} json
-   * @return {CssColorParser}
-   * @author: roman_123
-   */
-  export function fromJson(json: ColorJson): CssColorParser
-  /**
-   * @description: 将rgba数组转换为解析对象
-   * @param {Array} color
-   * @return {CssColorParser}
-   * @author: roman_123
-   */
-  export function fromArray(color: Array<number>): CssColorParser
-  export class CssColorParser {
-    r: number
-    g: number
-    b: number
-    a: number
-    constructor(
-      red?: number | string,
-      green?: number | string,
-      blue?: number | string,
-      alpha?: number | string
-    )
-    /**
-     * 设置颜色
-     * @param red
-     * @param green
-     * @param blue
-     * @param alpha
-     * @example: this.setColor(255,255,255,1)
-     */
-    setColor(
-      red?: number | string,
-      green?: number | string,
-      blue?: number | string,
-      alpha?: number | string
-    ): void
-    /**
-     * @description: 返回rgba格式的css字符串
-     * @return {*}
-     * @author: roman_123
-     */
-    toRGBA(): string
-    /**
-     * @description: 返回字符串
-     * @return {*}
-     * @author: roman_123
-     */
-    toString(): string
-    /**
-     * @description: 归一化
-     * @return {*}
-     * @author: roman_123
-     */
-    toNormalize(): ColorJson
-    /**
-     * @description: 返回16进制格式的css字符串
-     * @return {*}
-     * @author: roman_123
-     */
-    toHEX(): string
-    /**
-     * @description: 返回rgba数组
-     * @return {*}
-     * @author: roman_123
-     */
-    toArray(): number[]
-    /**
-     * @description: 返回ColorJson
-     * @return {*}
-     * @author: roman_123
-     */
-    toJson(): ColorJson
-    /**
-     * @description: 拷贝
-     * @return {*}
-     * @author: roman_123
-     */
-    clone(): CssColorParser
-    /**
-     * @description: 比较两个解析对象的数据是否相等
-     * @param {*} color
-     * @return {*}
-     * @author: roman_123
-     */
-    equals(color: any): boolean
-    /**
-     * @description: 解析16进制颜色
-     * @param {string} v
-     * @return {CssColorParser}
-     * @example: parseHEX('#FFF')
-     */
-    static parseHEX(v: string): CssColorParser
-    /**
-     * @description: 解析rgba、rgb颜色
-     * @param {string} v
-     * @return {CssColorParser}
-     * @example: parseRGBA('rgba(255,255,255,1)')
-     */
-    static parseRGBA(v: string): CssColorParser
-    /**
-     * @description: 将ColorJson格式的json数据转换为解析对象
-     * @param {ColorJson} json
-     * @return {CssColorParser}
-     * @example: fromJson({r: 255, g: 255, b: 255, a: 1})
-     */
-    static fromJson(json: ColorJson): CssColorParser
-    /**
-     * @description: 将RGBA数组转换为解析对象
-     * @param {Array} color
-     * @return {CssColorParser}
-     * @example: fromJson([255,255,255,1])
-     */
-    static fromArray(color: Array<number>): CssColorParser
-    /**
-     * @description: 产生随机颜色
-     * @return {CssColorParser}
-     * @example: fromRandom(new CssColorParser(0,0,0,0), new CssColorParser(255,255,255,1))
-     */
-    static fromRandom(
-      color1: CssColorParser,
-      color2: CssColorParser
-    ): CssColorParser
-  }
-}