# @spatial/square

> turf square module

Latest version **2.0.0** (published 2020-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @spatial/square
pnpm add @spatial/square
yarn add @spatial/square
bun add @spatial/square
```

## Health

**Score 50/100 (C)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score; popular repo.

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-09-18 |
| First published | 2019-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10482 |
| Author | Turf Authors |
| Maintainers | normanbreau, tpnormanbreau |
| Keywords | turf, gis, geojson, extent |

## Links

- npm: https://www.npmjs.com/package/@spatial/square
- Repository: https://github.com/Turfjs/turf
- Issues: https://github.com/Turfjs/turf/issues
- npm.io page: https://npm.io/package/@spatial/square

## Dependencies (2)

- [@spatial/helpers](https://npm.io/package/@spatial/helpers.md) ^2.0.0
- [@spatial/distance](https://npm.io/package/@spatial/distance.md) ^2.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-09-18
- 1.0.5 — 2019-08-09
- 1.0.4 — 2019-05-21
- 1.0.3 — 2019-05-21

## README

# @spatial/square

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## square

Takes a bounding box and calculates the minimum square bounding box that
would contain the input.

### Parameters

-   `bbox` **[BBox][1]** extent in [west, south, east, north] order

### Examples

```javascript
var bbox = [-20, -20, -15, 0];
var squared = turf.square(bbox);

//addToMap
var addToMap = [turf.bboxPolygon(bbox), turf.bboxPolygon(squared)]
```

Returns **[BBox][1]** a square surrounding `bbox`

[1]: https://tools.ietf.org/html/rfc7946#section-5

<!-- This file is automatically generated. Please don't edit it directly:
if you find an error, edit the source file (likely index.js), and re-run
./scripts/generate-readmes in the turf project. -->

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.

### Installation

Install this module individually:

```sh
$ npm install @spatial/square
```

Or install the Turf module that includes it as a function:

```sh
$ npm install @turf/turf
```

---
_Source: https://npm.io/package/@spatial/square · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._