@types/svg-intersections v0.4.4

Installation

npm install --save @types/svg-intersections

Summary

This package contains type definitions for svg-intersections (https://github.com/effektif/svg-intersections#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/svg-intersections.

index.d.ts

// Type definitions for svg-intersections 0.4
// Project: https://github.com/effektif/svg-intersections#readme
// Definitions by: xWiiLLz <https://github.com/xWiiLLz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

export type SvgElements = 'line' | 'rect' | 'circle' | 'ellipse' | 'polygon' | 'polyline' | 'path';

// Svg element properties
export interface LineProps {
    x1: number;
    y1: number;
    x2: number;
    y2: number;
}

export interface RectProps {
    rx?: number | undefined;
    ry?: number | undefined;
    x: number;
    y: number;
    width: number;
    height: number;
}

export interface CircleProps {
    cx: number;
    cy: number;
    r: number;
}

export interface EllipseProps {
    cx: number;
    cy: number;
    rx: number;
    ry: number;
}

export interface PolygonProps {
    points: string;
}

export type PolylineProps = PolygonProps;

export interface PathProps {
    d: string;
}

export type SvgProperties<T extends SvgElements> =
    T extends 'line' ? LineProps :
    T extends 'rect' ? RectProps :
    T extends 'circle' ? CircleProps :
    T extends 'ellipse' ? EllipseProps :
    T extends 'polygon' ? PolygonProps :
    T extends 'polyline' ? PolylineProps :
    T extends 'path' ? PathProps :
    never;

export interface Shape {
    type: string;
    meta: object;
    params: object;
}

export interface Matrix2D {
    a: number;
    b: number;
    c: number;
    d: number;
    e: number;
    f: number;
}

export interface Point2D {
    x: number;
    y: number;
}

export interface Intersection {
    status: string;
    points: Point2D[];
}

export function shape<T extends SvgElements>(svgElementName: T, svgProps: SvgProperties<T>): Shape;
export function intersect(shape1: Shape, shape2: Shape, m1?: Matrix2D, m2?: Matrix2D): Intersection;

Additional Details

• Last updated: Fri, 02 Jul 2021 22:33:11 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by xWiiLLz.