# @swim/mapping

> Functional maps, interpolators, and scales

Latest version **3.11.1** (published 2021-08-17) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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.11.1 |
| Published | 2021-08-17 |
| First published | 2021-03-31 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 458.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chris Sachs |
| Maintainers | c9r |

## Links

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

## Dependencies (1)

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

## Recent versions

- 3.11.1 (latest) — 2021-08-17
- 4.0.0-dev.20210927.3 (dev) — 2024-04-04
- 4.0.0-dev.20210927.2 — 2021-11-11
- 4.0.0-dev.20210927.1 — 2021-09-27
- 4.0.0-dev.20210927 — 2021-09-27
- 4.0.0-dev.20210923 — 2021-09-23
- 4.0.0-dev.20210920 — 2021-09-20
- 4.0.0-dev.20210826 — 2021-08-26
- 3.11.0 — 2021-08-15
- 3.11.0-dev.20210722 — 2021-07-22
- 3.11.0-dev.20210702 — 2021-07-03
- 3.11.0-dev.20210618 — 2021-06-18
- 3.11.0-dev.20210611.1 — 2021-06-11
- 3.11.0-dev.20210611 — 2021-06-11
- 3.11.0-dev.20210415 — 2021-04-15
- … 8 more at https://npm.io/package/@swim/mapping/versions

## README

# @swim/mapping

[![package](https://img.shields.io/npm/v/@swim/mapping.svg)](https://www.npmjs.com/package/@swim/mapping)
[![documentation](https://img.shields.io/badge/doc-TypeDoc-blue.svg)](https://docs.swimos.org/js/latest/modules/_swim_mapping.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/mapping** implements functional maps, interpolators, and scales.  **@swim/mapping** is part of the
[**@swim/core**](https://github.com/swimos/swim/tree/master/swim-system-js/swim-core-js/@swim/core) framework.

## Installation

### npm

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

### Browser

Browser applications can load `swim-core.js`, which comes bundled with the
**@swim/mapping** library, directly from the SwimOS CDN.

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

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

Alternatively, the standalone `swim-system.js` script may be loaded
from the SwimOS CDN, which bundles **@swim/mapping** 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/mapping** can be imported as an ES6 module from TypeScript and other
ES6-compatible environments.

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

### CommonJS/Node.js

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

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

### Browser

When loaded by a web browser, the `swim-core.js` script adds all
**@swim/mapping** library exports to the global `swim` namespace.

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

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