Skip to content

Commit

Permalink
Release 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Avaq committed Jan 28, 2019
1 parent 3e3d94f commit 5290384
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 18 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# fluture-sanctuary-types

[![Greenkeeper badge](https://badges.greenkeeper.io/fluture-js/fluture-sanctuary-types.svg)](https://greenkeeper.io/)
[![Chat](https://badges.gitter.im/fluture-js/fluture-sanctuary-types.svg)](https://gitter.im/fluture-js/fluture)
[![NPM Version](https://badge.fury.io/js/fluture-sanctuary-types.svg)](https://www.npmjs.com/package/fluture-sanctuary-types)
[![Dependencies](https://david-dm.org/fluture-js/fluture-sanctuary-types.svg)](https://david-dm.org/fluture-js/fluture-sanctuary-types)
[![Build Status](https://travis-ci.org/fluture-js/fluture-sanctuary-types.svg?branch=master)](https://travis-ci.org/fluture-js/fluture-sanctuary-types)
[![Code Coverage](https://codecov.io/gh/fluture-js/fluture-sanctuary-types/branch/master/graph/badge.svg)](https://codecov.io/gh/fluture-js/fluture-sanctuary-types)

[Fluture][] type definitions for [Sanctuary][].

```console
Expand All @@ -16,16 +9,13 @@ $ npm install --save fluture sanctuary-def fluture-sanctuary-types
## Usage

```js
const {create, env} = require ('sanctuary-def');
const {env: flutureEnv} = require ('fluture-sanctuary-types');
const Future = require ('fluture');
import $ = from 'sanctuary-def';
import {env} from 'fluture-sanctuary-types';

const def = create ({checkTypes: true, env: env.concat (flutureEnv)});
const def = $.create ({checkTypes: true, env: $.env.concat (env)});
```

## API

#### <a name="FutureType" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/v2.2.2/index.js#L52">`FutureType :: Type -⁠> Type -⁠> Type`</a>
#### <a name="FutureType" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/master/index.mjs#L25">`FutureType :: Type -⁠> Type -⁠> Type`</a>

The binary type constructor for members of Future.

Expand All @@ -34,7 +24,7 @@ The binary type constructor for members of Future.
true
```

#### <a name="ConcurrentFutureType" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/v2.2.2/index.js#L67">`ConcurrentFutureType :: Type -⁠> Type -⁠> Type`</a>
#### <a name="ConcurrentFutureType" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/master/index.mjs#L40">`ConcurrentFutureType :: Type -⁠> Type -⁠> Type`</a>

The binary type constructor for members of ConcurrentFuture.

Expand All @@ -46,11 +36,11 @@ The binary type constructor for members of ConcurrentFuture.
true
```

#### <a name="env" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/v2.2.2/index.js#L85">`env :: Array Type`</a>
#### <a name="env" href="https://github.com/fluture-js/fluture-sanctuary-types/blob/master/index.mjs#L58">`env :: Array Type`</a>

An Array containing all types applied to [`$.Unknown`][Unknown] for
direct use as a Sanctuary environment, as shown in [Usage](#usage).

[Fluture]: https://github.com/fluture-js/Fluture
[Sanctuary]: https://sanctuary.js.org/
[Unknown]: https://github.com/sanctuary-js/sanctuary-def/tree/v0.18.1#Unknown
[Unknown]: v:sanctuary-js/sanctuary-def#Unknown
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fluture-sanctuary-types",
"version": "2.2.2",
"version": "3.0.0",
"description": "Fluture type definitions for Sanctuary",
"main": "index",
"scripts": {
Expand Down

0 comments on commit 5290384

Please sign in to comment.