# data-optional

> Simple Java8-inspired monadic class to represent optional values

Latest version **0.0.2** (published 2017-05-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install data-optional
pnpm add data-optional
yarn add data-optional
bun add data-optional
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-05-08 |
| First published | 2017-05-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pedro M. Silva |
| Maintainers | pedromsilva |
| Keywords | js, immutable, optional, monadic, data, values, container |

## Links

- npm: https://www.npmjs.com/package/data-optional
- Repository: https://github.com/scorchpt/data-optional
- Homepage: https://github.com/scorchpt/data-optional#readme
- Issues: https://github.com/scorchpt/data-optional/issues
- npm.io page: https://npm.io/package/data-optional

## 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

- 0.0.2 (latest) — 2017-05-08
- 0.0.1 — 2017-05-08

## README

# Optional

> Simple Java8-inspired monadic class to represent optional values

# Installation
```shell
npm install --save data-optional
```

# Usage
```typescript
import Optional from 'data-optional';

const empty = Optional.empty();
const value = Optional.of( 20 );

empty.isPresent(); // false
value.isPresent(); // true
```

You can also convert nullable types into optionals.
```typescript
import { Optional } from 'data-optional';

const empty = Optional.ofNullable( null );
const value = Optional.ofNullable( 1 );

empty.isPresent(); // false
value.isPresent(); // true
```

There are also a number of computations that can be done functionally with this module.
```typescript
import { Optional } from 'data-optional';

value = Optional.ofNullable( 1 );

value = value.map( n => n * 3 ); // Optional.of( 3 )

value = value.flatMap( n => n % 2 === 0 ? Optional.of( n ) : Optional.empty() ); // Optional.empty()

value.orElse( 0 ); // 0
```

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