css-color-parser-h 1.0.5 → 2.0.0

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

@@ -0,0 +1,201 @@
+/*
+ * @Author: roman_123
+ * @Description:
+ * @Date: 2023-05-26 13:29:45
+ * @LastEditTime: 2023-05-26 13:58:07
+ */
+export class ColorJson {
+  r: number
+  g: number
+  b: number
+  a: number
+}
+declare module 'css-color-parser-h' {
+  /**
+   * @description: 将css KeyWord字符串转换为解析对象
+   * @param {string} v
+   * @return {CssColorParser}
+   * @example: parseKeyWord('red')
+   */
+  export function parseKeyWord(v: string): CssColorParser
+  /**
+   * @description: 将css HEX字符串转换为解析对象
+   * @param {string} v
+   * @return {CssColorParser}
+   * @example: parseHEX('#ccc')
+   */
+  export function parseHEX(v: string): CssColorParser
+  /**
+   * @description: 将css RGBA字符串转换为解析对象
+   * @param {string} v
+   * @return {CssColorParser}
+   * @example: parseRGBA('rgb(255,255,255)')
+   */
+  export function parseRGBA(v: string): CssColorParser
+  /**
+   * @description: 将css HSLA字符串转换为解析对象
+   * @param {string} v
+   * @return {CssColorParser}
+   * @example: parseHSLA('hsl(215 85% 62% / 0.8)')
+   */
+  export function parseHSLA(v: string): CssColorParser
+  /**
+   * @description: 将css HSLA字符串转换为解析对象
+   * @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}
+   * @author: roman_123
+   */
+  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
+    /**
+     * 设置颜色
+     * @param red
+     * @param green
+     * @param blue
+     * @param alpha
+     * @example: const parser = new CssColorParser(255,255,255,1)
+     */
+    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
+  }
+}

package/@types/index.d.ts

@@ -0,0 +1,10 @@
+/*
+ * @Author: roman_123
+ * @Description: 声明全局变量，仅在全局引入umd时有效
+ * @Date: 2023-05-26 13:45:44
+ * @LastEditTime: 2023-05-26 14:08:35
+ */
+import CssParser from 'css-color-parser-h'
+declare global {
+  const Parser: typeof CssParser
+}