@types/array-bounds
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

Installation

npm install --save @types/array-bounds

Summary

This package contains type definitions for array-bounds (https://github.com/dfcreative/array-bounds#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/array-bounds.

index.d.ts

export = getBounds;

/**
 * Find min and max values of a sequence of values/coordinates.
 * @param array
 * @param [stride=1] The stride to use, ie. for 1d values expected data layout is
 * `[x, x, x, ...]` for 2d is `[x, y, x, y, ...]`, etc.
 * @returns An array that contains bounds for every dimension as `[minX, minY, ..., maxX, maxY]`, eg.
 * ```
 * //get bounding box
 * let [minX, minY, maxX, maxY] = bounds([x1, y1, x2, y2, x3, y3, ...], 2)
 *
 * //get bounding cube
 * let [minX, minY, minZ, maxX, maxY, maxZ] = bounds([x1, y1, z1, x2, y2, z2, ...], 3)
 * ```
 *
 * @example
 * import getBounds = require('array-bounds')
 *
 * const bounds = getBounds([0, 25, 50, 75, 100]) // [0, 100]
 */
declare function getBounds(array: ArrayLike<number>, stride?: number): number[];

Additional Details

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

Credits

These definitions were written by BendingBender.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/array-bounds

Weekly Downloads

71

Version

1.0.2

License

MIT

Unpacked Size

4.15 kB

Total Files

5

Last publish

Collaborators

  • types