JSPM

@types/concaveman

1.1.6
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 26621
  • Score
    100M100P100Q143484F
  • License MIT

TypeScript definitions for concaveman

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/concaveman) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/concaveman

    Summary

    This package contains type definitions for concaveman (https://github.com/mapbox/concaveman).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/concaveman.

    index.d.ts

    declare module "concaveman" {
        /**
         * A very fast 2D concave hull algorithm in JavaScript (generates a general outline of a point set).
         *
         * @name concaveman
         * @param {Array<Array<number>>} points is an array of [x, y] points.
         * @param {number} [concavity=2] is a relative measure of concavity. 1 results in a relatively detailed shape, Infinity results in a convex hull. You can use values lower than 1, but they can produce pretty crazy shapes.
         * @param {number} [lengthThreshold=0] when a segment length is under this threshold, it stops being considered for further detalization. Higher values result in simpler shapes.
         * @return {Array<Array<number>>}
         * @example
         * var points = [[10, 20], [30, 12.5], ...];
         * var polygon = concaveman(points);
         *
         * //=hull
         */
        function concaveman(points: number[][], concavity?: number, lengthThreshold?: number): number[][];
        namespace concaveman {}
        export = concaveman;
    }
    

    Additional Details

    • Last updated: Mon, 06 Nov 2023 22:41:05 GMT
    • Dependencies: none

    Credits

    These definitions were written by Denis Carriere.