# @swim/length

> DOM-relative length types with unit-aware algebraic operators, conversions, and parsers

Latest version **3.10.2** (published 2020-01-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @swim/length
pnpm add @swim/length
yarn add @swim/length
bun add @swim/length
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.10.2 |
| Published | 2020-01-20 |
| First published | 2019-02-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 217.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chris Sachs |
| Maintainers | c9r, ctrinh, scottswim, swim-iot |

## Links

- npm: https://www.npmjs.com/package/@swim/length
- Repository: https://github.com/swimos/swim
- Homepage: https://github.com/swimos/swim/tree/master/swim-system-js/swim-ui-js/@swim/length
- Issues: https://github.com/swimos/swim/issues
- npm.io page: https://npm.io/package/@swim/length

## Dependencies (3)

- [@swim/util](https://npm.io/package/@swim/util.md) 3.10.2
- [@swim/codec](https://npm.io/package/@swim/codec.md) 3.10.2
- [@swim/structure](https://npm.io/package/@swim/structure.md) 3.10.2

## Recent versions

- 3.10.2 (latest) — 2020-01-20
- 3.11.0-dev.20200619 (dev) — 2020-06-19
- 3.11.0-dev.20200517 — 2020-05-17
- 3.10.1 — 2019-08-19
- 3.10.0 — 2019-07-22
- 3.9.0 — 2019-02-18

## README

# @swim/length

[![package](https://img.shields.io/npm/v/@swim/length.svg)](https://www.npmjs.com/package/@swim/length)
[![documentation](https://img.shields.io/badge/doc-TypeDoc-blue.svg)](https://docs.swimos.org/js/latest/modules/_swim_length.html)
[![chat](https://img.shields.io/badge/chat-Gitter-green.svg)](https://gitter.im/swimos/community)

<a href="https://www.swimos.org"><img src="https://docs.swimos.org/readme/marlin-blue.svg" align="left"></a>

**@swim/length** implements DOM-relative length types with unit-aware algebraic
operators, conversions, and parsers.  **@swim/length** is part of the
[**@swim/ui**](https://github.com/swimos/swim/tree/master/swim-system-js/swim-ui-js/@swim/ui)
framework.

## Installation

### npm

For an npm-managed project, `npm install @swim/length` to make it a dependency.
TypeScript sources will be installed into `node_modules/@swim/length/main`.
Transpiled JavaScript and TypeScript definition files install into
`node_modules/@swim/length/lib/main`.  And a pre-built UMD script can
be found in `node_modules/@swim/length/dist/main/swim-length.js`.

### Browser

Browser applications can load `swim-ui.js`—which bundles the **@swim/length**
library—along with its `swim-core.js` dependency, directly from the swimOS CDN.

```html
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>
```

Alternatively, the standalone `swim-system.js` script may be loaded
from the swimOS CDN, which bundles **@swim/length** together with all other
[**@swim/system**](https://github.com/swimos/swim/tree/master/swim-system-js/@swim/system)
libraries.

```html
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
```

## Usage

### ES6/TypeScript

**@swim/length** can be imported as an ES6 module from TypeScript and other
ES6-compatible environments.

```typescript
import * as length from "@swim/length";
```

### CommonJS/Node.js

**@swim/length** can also be used as a CommonJS module in Node.js applications.

```javascript
var length = require("@swim/length");
```

### Browser

When loaded by a web browser, the `swim-ui.js` script adds all
**@swim/length** library exports to the global `swim` namespace.  The
`swim-ui.js` script requires that `swim-core.js` has already been loaded.

The `swim-system.js` script also adds all **@swim/length** library exports
to the global `swim` namespace, making it a drop-in replacement for
'swim-core.js' and `swim-ui.js` when additional **@swim/system**
libraries are needed.

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