Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
toomuchdesign committed Jan 23, 2019
1 parent c2be956 commit d46a861
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 41 deletions.
91 changes: 52 additions & 39 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,36 @@
# Change log

## 3.0.0

### Breaking Changes

* Update TypeScript typings
* Introduce typings for heterogeneous selectors
* Introduce typings for any number of uniform selectors

### New Features

* Update TypeScript typings
* Introduce typings for `dependencies` property

## 2.3.0

### New Features

- Do not include test files on publish
- Introduce new selectors' methods/properties:
- `dependencies` property
- `recomputations` method
- `resetRecomputations` method
* Do not include test files on publish
* Introduce new selectors' methods/properties:
* `dependencies` property
* `recomputations` method
* `resetRecomputations` method

## 2.2.0

- Fix cache object's `isValidCacheKey` method TS type definition
* Fix cache object's `isValidCacheKey` method TS type definition

### New Features

- Upgrade to babel 7
- Update dev dependencies
* Upgrade to babel 7
* Update dev dependencies

### Breaking Changes (not considered worth a major release)

Expand All @@ -27,83 +40,83 @@

### New Features

- Expose `cache` property
* Expose `cache` property

## 2.0.0

### Breaking Changes

- `cacheKey` values no more restricted by default to `number` or `string`
- `cacheKey` validation delegated to `cacheObject`'s `isValidCacheKey` method
- `selectorCreator` argument removed in favour of `options` object
- `console.warn` when `resolverFunction` returns invalid `cacheKey`
- `cacheObject` export names renamed _(old ones are deprecated)_:
- `FlatCacheObject` -> `FlatObjectCache`
- `FifoCacheObject` -> `FifoObjectCache`
- `LruCacheObject` -> `LruObjectCache`
* `cacheKey` values no more restricted by default to `number` or `string`
* `cacheKey` validation delegated to `cacheObject`'s `isValidCacheKey` method
* `selectorCreator` argument removed in favour of `options` object
* `console.warn` when `resolverFunction` returns invalid `cacheKey`
* `cacheObject` export names renamed _(old ones are deprecated)_:
* `FlatCacheObject` -> `FlatObjectCache`
* `FifoCacheObject` -> `FifoObjectCache`
* `LruCacheObject` -> `LruObjectCache`

### New Features

- Added 3 new `cacheObject` implementations using `ES Map` objects accepting any value as `cacheKey`:
- `FlatMapCache`
- `FifoMapCache`
- `LruMapCache`
- Add a `sideEffects: false` flag for Webpack 4
* Added 3 new `cacheObject` implementations using `ES Map` objects accepting any value as `cacheKey`:
* `FlatMapCache`
* `FifoMapCache`
* `LruMapCache`
* Add a `sideEffects: false` flag for Webpack 4

## 1.0.1

- Remove wrong line at the beginning of the docs
* Remove wrong line at the beginning of the docs

## 1.0.0

### Breaking Changes

- `selectorCreator` argument is deprecated in favour of an option object
* `selectorCreator` argument is deprecated in favour of an option object

### New Features

- Accept an option object to provide `cacheObject` and `selectorCreator` options
- Extract caching logic into pluggable/customizable cache objects
- Introduce `Rollup.js` as bundler
- Make compilation cross-platform
* Accept an option object to provide `cacheObject` and `selectorCreator` options
* Extract caching logic into pluggable/customizable cache objects
* Introduce `Rollup.js` as bundler
* Make compilation cross-platform

## 0.6.3

- Add TS type definition for optional `selectorCreator`
* Add TS type definition for optional `selectorCreator`

## 0.6.2

- Fix wrong UMD reselect global import
* Fix wrong UMD reselect global import

## 0.6.1

- Fix TypeScript `OutputCachedSelector` and `OutputParametricCachedSelector` type definitions
* Fix TypeScript `OutputCachedSelector` and `OutputParametricCachedSelector` type definitions

## 0.6.0

- Add TypeScript type definitions
* Add TypeScript type definitions

## 0.5.0

- Expose `resultFunc` attribute
* Expose `resultFunc` attribute

## 0.4.0

- Expose `removeMatchingSelector` method
- Expose `clearCache` method
* Expose `removeMatchingSelector` method
* Expose `clearCache` method

## 0.3.0

- Add UMD dist
* Add UMD dist

## 0.2.0

- Expose `getMatchingSelector` method to retrieve the instance of cached selectors
* Expose `getMatchingSelector` method to retrieve the instance of cached selectors

## 0.1.0

- Allow resolver function to return keys of type number
* Allow resolver function to return keys of type number

## 0.0.0

- Initial release
* Initial release
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -433,8 +433,6 @@ Reset `recomputations` count.

## Todo's

- Introduce typings for heterogeneous selectors. See [this](https://github.com/reduxjs/reselect/pull/274) and [this](https://github.com/toomuchdesign/re-reselect/pull/63).
- Consider introducing typings for `selector.dependencies` method
- Improve TS tests readability
- More examples

Expand Down

0 comments on commit d46a861

Please sign in to comment.