Options type definition

[Gabilabrebi]

It would be great to have a proper type definition for the options of this package.

The current exported types are really minimal and could easily be improved to include options

[rs3d]

Here are some type definitions I've created recently. I hope this helps

export enum QRCodeCorrectLevel {
  L = 1,
  M = 0,
  Q = 3,
  H = 2,
}

export type QrCodeConfig = {
  text: string;
  width?: number;
  height?: number;
  colorDark?: string;
  colorLight?: string;
  correctLevel?: QRCodeCorrectLevel;

  // dotScale
  dotScale?: number;
  dotScaleTiming?: number;
  dotScaleTiming_H?: number;
  dotScaleTiming_V?: number;
  dotScaleA?: number;
  dotScaleAO?: number;
  dotScaleAI?: number;

  // Quiet Zone
  quietZone?: number;
  quietZoneColor?: string;

  // Logo
  logo?: string;
  logoWidth?: number;
  logoHeight?: number;
  logoMaxWidth?: number;
  logoMaxHeight?: number;
  logoBackgroundColor?: string;
  logoBackgroundTransparent?: boolean;

  // Background Image
  backgroundImage?: string;
  backgroundImageAlpha?: number;
  autoColor?: boolean;
  autoColorDark?: string;
  autoColorLight?: string;

  // Position Pattern (Eye) Color
  PO?: string; // Global Position Outer
  PI?: string; // Global Position Inner
  PO_TL?: string; // Top Left
  PI_TL?: string;
  PO_TR?: string; // Top Right
  PI_TR?: string;
  PO_BL?: string; // Bottom Left
  PI_BL?: string;

  // Alignment Color
  AO?: string;
  AI?: string;

  // Timing Pattern Color
  timing?: string;
  timing_H?: string;
  timing_V?: string;

  // Title
  title?: string;
  titleFont?: string;
  titleColor?: string;
  titleBackgroundColor?: string;
  titleHeight?: number;
  titleTop?: number;

  // SubTitle
  subTitle?: string;
  subTitleFont?: string;
  subTitleColor?: string;
  subTitleTop?: number;

  // Event Handlers
  onRenderingStart?: (options: QrCodeConfig) => void;
  onRenderingEnd?: (options: QrCodeConfig, dataURL: string) => void;

  // Settings & Meta
  version?: number; // 0 - 40
  binary?: boolean;
  tooltip?: boolean;
  crossOrigin?: string | null;
  drawer?: 'canvas' | 'svg';
  utf8WithoutBOM?: boolean;
};