svg-pathdata/src/types.ts

Manipulate SVG path data (path[d] attribute content) simply and efficiently.

import { SVGPathData } from './SVGPathData.js';

export interface CommandM {
  relative: boolean;
  type: typeof SVGPathData.MOVE_TO;
  x: number;
  y: number;
}
export interface CommandL {
  relative: boolean;
  type: typeof SVGPathData.LINE_TO;
  x: number;
  y: number;
}
export interface CommandH {
  relative: boolean;
  type: typeof SVGPathData.HORIZ_LINE_TO;
  x: number;
}
export interface CommandV {
  relative: boolean;
  type: typeof SVGPathData.VERT_LINE_TO;
  y: number;
}
export interface CommandZ {
  type: typeof SVGPathData.CLOSE_PATH;
}
export interface CommandQ {
  relative: boolean;
  type: typeof SVGPathData.QUAD_TO;
  x1: number;
  y1: number;
  x: number;
  y: number;
}
export interface CommandT {
  relative: boolean;
  type: typeof SVGPathData.SMOOTH_QUAD_TO;
  x: number;
  y: number;
}
export interface CommandC {
  relative: boolean;
  type: typeof SVGPathData.CURVE_TO;
  x1: number;
  y1: number;
  x2: number;
  y2: number;
  x: number;
  y: number;
}
export interface CommandS {
  relative: boolean;
  type: typeof SVGPathData.SMOOTH_CURVE_TO;
  x2: number;
  y2: number;
  x: number;
  y: number;
}
export interface CommandA {
  relative: boolean;
  type: typeof SVGPathData.ARC;
  rX: number;
  rY: number;
  xRot: number;
  sweepFlag: 0 | 1;
  lArcFlag: 0 | 1;
  x: number;
  y: number;
  cX?: number;
  cY?: number;
  phi1?: number;
  phi2?: number;
}
export type SVGCommand =
  | CommandM
  | CommandL
  | CommandH
  | CommandV
  | CommandZ
  | CommandQ
  | CommandT
  | CommandC
  | CommandS
  | CommandA;

export type TransformFunction = (
  input: SVGCommand,
) => SVGCommand | SVGCommand[];