css-color-parser-h 2.0.4 → 3.0.0

package/@types/index.d.ts

@@ -2,7 +2,7 @@
  * @Author: roman_123
  * @Description:
  * @Date: 2023-05-26 13:29:45
- * @LastEditTime: 2023-06-03 13:23:36
+ * @LastEditTime: 2023-06-27 19:23:00
  */
 declare module 'css-color-parser-h' {
   class ColorJson {
@@ -11,125 +11,29 @@ declare module 'css-color-parser-h' {
     b: number
     a: number
   }
-  /**
-   * @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;
-    private _outColorPrecision;
-    private _outAlphaPrecision;
-    constructor(red?: number | string, green?: number | string, blue?: number | string, alpha?: number | string);
+    r: number
+    g: number
+    b: number
+    a: number
+    private _outColorPrecision
+    private _outAlphaPrecision
+    constructor(
+      red?: number | string,
+      green?: number | string,
+      blue?: number | string,
+      alpha?: number | string
+    )
     /**
      * @description: 设置CssColorParser实例输出的精度
      * @param {number} colorPrecision 输出颜色的精度
      * @param {number} outAlphaPrecision 输出透明度的精度
      * @return {CssColorParser}
      */
-    setOutPrecision(colorPrecision: number, outAlphaPrecision: number): CssColorParser;
+    setOutPrecision(
+      colorPrecision: number,
+      outAlphaPrecision: number
+    ): CssColorParser
     /**
      * 设置颜色
      * @param red
@@ -138,175 +42,347 @@ declare module 'css-color-parser-h' {
      * @param alpha
      * @example: this.setColor(255,255,255,1)
      */
-    setColor(red?: number | string, green?: number | string, blue?: number | string, alpha?: number | string): CssColorParser;
+    setColor(
+      red?: number | string,
+      green?: number | string,
+      blue?: number | string,
+      alpha?: number | string
+    ): CssColorParser
     /**
      * @description: 设置透明度
      * @param {number} alpha
      * @return {CssColorParser}
      */
-    setAlpha(alpha?: number | string): CssColorParser;
+    setAlpha(alpha?: number | string): CssColorParser
     /**
      * @description: 设置红色值
      * @param {number} red
      * @return {CssColorParser}
      */
-    setRed(red?: number | string): CssColorParser;
+    setRed(red?: number | string): CssColorParser
     /**
      * @description: 设置绿色值
      * @param {number} green
      * @return {CssColorParser}
      */
-    setGreen(green?: number | string): CssColorParser;
+    setGreen(green?: number | string): CssColorParser
     /**
      * @description: 设置蓝色值
      * @param {number} blue
      * @return {CssColorParser}
      */
-    setBlue(blue?: number | string): CssColorParser;
+    setBlue(blue?: number | string): CssColorParser
     /**
      * @description: 返回rgba格式的css字符串
      * @return {string}
      */
-    toRGBA(): string;
+    toRGBA(): string
     /**
      * @description: 返回字符串
      * @return {string}
      */
-    toString(): string;
+    toString(): string
     /**
      * @description: 归一化
      * @return {array}
      */
-    toNormalize(): [number, number, number, number];
+    toNormalize(): [number, number, number, number]
     /**
      * @description: 返回16进制格式的css字符串
      * @return {string}
      */
-    toHEX(): string;
+    toHEX(): string
     /**
      * @description: 返回rgba数组
      * @return {array}
      */
-    toArray(): [number, number, number, number];
+    toArray(): [number, number, number, number]
     /**
      * @description: 返回ColorJson
      * @return {ColorJson}
      */
-    toJson(): ColorJson;
+    toJson(): ColorJson
     /**
-     * @description: 返回反色的CssColorParser实例
+     * @description: 返回取反色后的新的实例
      * @return {CssColorParser}
      */
-    toInvert(): CssColorParser;
+    toInvert(): CssColorParser
     /**
      * @description: 拷贝
      * @return {CssColorParser}
      */
-    clone(): CssColorParser;
+    clone(): CssColorParser
     /**
      * @description: 比较两个解析对象的数据是否相等
      * @param {string} color
      * @return {boolean}
      */
-    equals(color: CssColorParser): boolean;
+    equals(color: CssColorParser): boolean
     /**
      * @description: 反色
      * @return {CssColorParser}
      */
-    setInvert(): CssColorParser;
+    setInvert(): CssColorParser
     /**
      * @description: 乘以倍数
      * @param {number} scalar
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    multiplyByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser;
+    multiplyByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 除以倍数
      * @param {number} scalar
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    divideByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser;
+    divideByScalar(scalar: number, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 实例相加
      * @param {CssColorParser} colorParser
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    add(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+    add(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 实例相减
      * @param {CssColorParser} colorParser
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    subtract(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+    subtract(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 实例相乘
      * @param {CssColorParser} colorParser
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    multiply(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+    multiply(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 实例相除
      * @param {CssColorParser} colorParser
      * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
      * @return {CssColorParser}
      */
-    divide(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser;
+    divide(colorParser: CssColorParser, isSetAlpha?: boolean): CssColorParser
     /**
      * @description: 颜色RGB加上数字
      * @param {number} num
      * @return {CssColorParser}
      */
-    addNumberForRGB(num: number): CssColorParser;
+    addNumberForRGB(num: number): CssColorParser
     /**
      * @description: 透明度加上数字
      * @param {number} num
      * @return {CssColorParser}
      */
-    addNumberForAlpha(num: number): CssColorParser;
+    addNumberForAlpha(num: number): CssColorParser
     /**
      * @description: 解析16进制颜色
      * @param {string} v
      * @return {CssColorParser}
      * @example: CssColorParser.parseHEX('#FFF')
      */
-    static parseHEX(v: string): CssColorParser;
+    static parseHEX(v: string): CssColorParser
     /**
      * @description: 解析rgba、rgb颜色
      * @param {string} v
      * @return {CssColorParser}
      * @example: CssColorParser.parseRGBA('rgba(255,255,255,1)')
      */
-    static parseRGBA(v: string): CssColorParser;
+    static parseRGBA(v: string): CssColorParser
     /**
      * @description: 将ColorJson格式的json数据转换为解析对象
      * @param {ColorJson} json
      * @return {CssColorParser}
      * @example: CssColorParser.fromJson({r: 255, g: 255, b: 255, a: 1})
      */
-    static fromJson(json: ColorJson): CssColorParser;
+    static fromJson(json: ColorJson): CssColorParser
     /**
      * @description: 将RGBA数组转换为解析对象
      * @param {Array} color
      * @return {CssColorParser}
      * @example: CssColorParser.fromArray([255,255,255,1])
      */
-    static fromArray(color: Array<number>): CssColorParser;
+    static fromArray(color: Array<number>): CssColorParser
     /**
      * @description: 产生随机颜色
      * @return {CssColorParser}
      * @example: CssColorParser.fromRandom(new CssColorParser(0,0,0,0), new CssColorParser(255,255,255,1))
      */
-    static fromRandom(color1: CssColorParser, color2: CssColorParser): CssColorParser;
+    static fromRandom(
+      color1: CssColorParser,
+      color2: CssColorParser
+    ): CssColorParser
     /**
      * @description: 颜色序列化数组转换为CssColorParser对象实例
      * @param {array} colorArr
      * @example: CssColorParser.fromNormaliz([1, 0, 0, 1])
      */
-    static fromNormalize(colorArr: [number, number, number, number]): CssColorParser;
+    static fromNormalize(
+      colorArr: [number, number, number, number]
+    ): CssColorParser
+  }
+  export class CssColorParserPlus extends CssColorParser {
+    /**
+     * @description: 返回取反色后的新的实例
+     * @return {CssColorParserPlus}
+     */
+    toInvert(): CssColorParserPlus
+    /**
+     * @description: 拷贝
+     * @return {CssColorParserPlus}
+     */
+    clone(): CssColorParserPlus
+    /**
+     * @description: 比较两个解析对象的数据是否相等
+     * @param {string} color
+     * @return {boolean}
+     */
+    equals(color: CssColorParser | string): boolean
+    /**
+     * @description: 实例相加
+     * @param {CssColorParser} colorParser
+     * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
+     * @return {CssColorParser}
+     */
+    add(color: CssColorParser | string, isSetAlpha?: boolean): CssColorParser
+    /**
+     * @description: 实例相减
+     * @param {CssColorParser} colorParser
+     * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
+     * @return {CssColorParser}
+     */
+    subtract(
+      color: CssColorParser | string,
+      isSetAlpha?: boolean
+    ): CssColorParser
+    /**
+     * @description: 实例相乘
+     * @param {CssColorParser} colorParser
+     * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
+     * @return {CssColorParser}
+     */
+    multiply(
+      color: CssColorParser | string,
+      isSetAlpha?: boolean
+    ): CssColorParser
+    /**
+     * @description: 实例相除
+     * @param {CssColorParser} colorParser
+     * @param {boolean} isSetAlpha 透明度值是否参与计算（默认：是）
+     * @return {CssColorParser}
+     */
+    divide(color: CssColorParser | string, isSetAlpha?: boolean): CssColorParser
+    /**
+     * @description: 解析css颜色
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: parseCssColorStr('rgba(255,255,255,1)')
+     */
+    static parseColor(v: string | CssColorParser): CssColorParser
+    /**
+     * @description: 将css字符串转换为解析对象
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: parseCssColorStr('rgba(255,255,255,1)')
+     */
+    static parseCssColorStr(v: string): CssColorParserPlus
+    /**
+     * @description: 解析颜色关键字
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: parseKeyWord('red')
+     */
+    static parseKeyWord(v: string): CssColorParserPlus
+    /**
+     * @description: 解析HSLA
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: parseHSLA('hsla(215,85%,62%,0.8)')
+     */
+    static parseHSLA(v: string): CssColorParserPlus
+    /**
+     * @description: 解析HWB
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: parseHWB('hwb(215deg 30% 6% / 80%)')
+     */
+    static parseHWB(v: string): CssColorParserPlus
+    /**
+     * @description: 将HSL色彩模式转换为解析对象
+     * @param {number} hue 色相
+     * @param {number} saturation 饱和度
+     * @param {number} lightness 亮度
+     * @param {number} alpha 不透明度
+     * @return {CssColorParserPlus}
+     * @example: fromHSL(0,1,1,1)
+     */
+    static fromHSL(
+      h: number,
+      s: number,
+      l: number,
+      a?: number
+    ): CssColorParserPlus
+    /**
+     * @description: 将HWB色彩模式转换为解析对象
+     * @param {number} h 色调
+     * @param {number} w 白度
+     * @param {number} b 黑度
+     * @param {number} a 不透明度
+     * @return {CssColorParserPlus}
+     * @example: fromHSL(0,1,1,1)
+     */
+    static fromHWB(
+      h: number,
+      w: number,
+      b: number,
+      a?: number
+    ): CssColorParserPlus
+    /**
+     * @description: 解析16进制颜色
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: CssColorParserPlus.parseHEX('#FFF')
+     */
+    static parseHEX(v: string): CssColorParserPlus
+    /**
+     * @description: 解析rgba、rgb颜色
+     * @param {string} v
+     * @return {CssColorParserPlus}
+     * @example: CssColorParserPlus.parseRGBA('rgba(255,255,255,1)')
+     */
+    static parseRGBA(v: string): CssColorParserPlus
+    /**
+     * @description: 将ColorJson格式的json数据转换为解析对象
+     * @param {ColorJson} json
+     * @return {CssColorParserPlus}
+     * @example: CssColorParserPlus.fromJson({r: 255, g: 255, b: 255, a: 1})
+     */
+    static fromJson(json: ColorJson): CssColorParserPlus
+    /**
+     * @description: 将RGBA数组转换为解析对象
+     * @param {Array} color
+     * @return {CssColorParserPlus}
+     * @example: CssColorParserPlus.fromArray([255,255,255,1])
+     */
+    static fromArray(color: Array<number>): CssColorParserPlus
+    /**
+     * @description: 产生随机颜色
+     * @return {CssColorParserPlus}
+     * @example: CssColorParserPlus.fromRandom('black', new CssColorParserPlus(255,255,255,1))
+     */
+    static fromRandom(
+      color1: CssColorParserPlus | string,
+      color2: CssColorParserPlus | string
+    ): CssColorParserPlus
+    /**
+     * @description: 颜色序列化数组转换为CssColorParserPlus对象实例
+     * @param {array} colorArr
+     * @example: CssColorParserPlus.fromNormaliz([1, 0, 0, 1])
+     */
+    static fromNormalize(
+      colorArr: [number, number, number, number]
+    ): CssColorParserPlus
   }
 }