Method hwb

src/modules/color/index.ts:711–728

* Returns an HWB color. * * @param options Options object. * @param options.format Format of generated RGB color. Defaults to `'decimal'`. * * @example * faker.color.hwb() // [201, 0.21, 0.31] * faker.color.hwb({ format: 'decimal' }) // [201, 0.21, 0.31] * faker.color.hwb({ f

(
    options: {
      /**
       * Format of generated RGB color.
       *
       * @default 'decimal'
       */
      format?: ColorFormat;
    } = {}
  )

   * @since 7.0.0
   */
  hwb(
    options: {
      /**
       * Format of generated RGB color.
       *
       * @default 'decimal'
       */
      format?: ColorFormat;
    } = {}
  ): string | number[] {
    const { format = 'decimal' } = options;
    const hsl: number[] = [this.faker.number.int(360)];
    for (let i = 0; i < 2; i++) {
      hsl.push(this.faker.number.float({ multipleOf: 0.01 }));
    }

    return toColorFormat(hsl, format, 'hwb');
  }

  /**
   * Returns a LAB (CIELAB) color.