# slf-js

> Selafin file reader and writter (OpenTelemac)

Latest version **0.0.7** (published 2018-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install slf-js
pnpm add slf-js
yarn add slf-js
bun add slf-js
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2018-11-15 |
| First published | 2017-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 13 |
| Unpacked size | 363.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Julien Cousineau |
| Maintainers | julien.cousineau |
| Keywords | selafin, telemac |

## Links

- npm: https://www.npmjs.com/package/slf-js
- Repository: https://github.com/Julien-Cousineau/slf-js
- Homepage: https://github.com/Julien-Cousineau/slf-js#readme
- Issues: https://github.com/Julien-Cousineau/slf-js/issues
- npm.io page: https://npm.io/package/slf-js

## Dependencies (13)

- [tape](https://npm.io/package/tape.md) ^4.8.0
- [proj4](https://npm.io/package/proj4.md) ^2.4.4
- [rbush](https://npm.io/package/rbush.md) ^2.0.2
- [eslint](https://npm.io/package/eslint.md) ^5.9.0
- [faucet](https://npm.io/package/faucet.md) 0.0.1
- [@turf/area](https://npm.io/package/@turf/area.md) ^6.0.1
- [@turf/mask](https://npm.io/package/@turf/mask.md) ^5.1.5
- [@turf/helpers](https://npm.io/package/@turf/helpers.md) ^6.1.4
- [@mapbox/tilebelt](https://npm.io/package/@mapbox/tilebelt.md) ^1.0.1
- [@mapbox/tile-cover](https://npm.io/package/@mapbox/tile-cover.md) ^3.0.2
- [@turf/bbox-polygon](https://npm.io/package/@turf/bbox-polygon.md) ^6.0.1
- [@julien.cousineau/util](https://npm.io/package/@julien.cousineau/util.md) ^1.0.14
- [martinez-polygon-clipping](https://npm.io/package/martinez-polygon-clipping.md) ^0.5.0

## Recent versions

- 0.0.7 (latest) — 2018-11-15
- 0.0.6 — 2018-11-14
- 0.0.5 — 2018-11-11
- 0.0.4 — 2018-08-27
- 0.0.3 — 2017-10-26
- 0.0.2 — 2017-10-25
- 0.0.1 — 2017-10-24

## README

# slf-js
A JavaScript Selafin reader and writer ([OpenTelemac](https://opentelemac.org)).

## Install

Install using NPM (`npm install slf-js`), then:

```js
// import as a ES module
import Selafin from 'slf-js';

// or require in Node / Browserify
const Selafin = require('slf-js');
```

Or use a browser build directly:

```html
<script src="https://unpkg.com/slfjs@0.0.5/slfjs.min.js"></script>
```

## Usage

#### new Selafin([buffer, options])

Creates a Selafin object.

1. `buffer` : Buffer/Binary data container the selafin object.
1. `options`: Options.
- `debug`: Debug mode, `false` by default.
- `fromProj`: Orginal projection. `EPSG:4326` by default.
- `toProj`: Transformation projection. `EPSG:4326` by default.

```js
const slf = new Selafin(); // new without any file/buffer
const slf = new Selafin(buffer,{debug:true}); // from file/buffer
```

#### Selafin Properties

- `MESHX` : X Coordinate.
- `MESHY` : Y Coordinate.


## Options
Empty


## Compile, Test, Benchmark Cases
```js

npm run test
npm run build
```

## Examples
Empty

## History
0.0.5 - Created selafingl (webgl) and selafinmp(webgl+mapbox)

## TODO
- Complete readme
- Complete and have better test cases
- Not sure if Proj4 should be in here

## License

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