From af4f556ac86b56e2454c7a5183e16f1f0a28997b Mon Sep 17 00:00:00 2001 From: Krunoslav Zaher Date: Mon, 16 Nov 2015 00:37:18 +0100 Subject: [PATCH] Updates documentation. --- CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++ Documentation/API.md | 13 +++++++++---- 2 files changed, 44 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63db7731..2c618c7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,41 @@ All notable changes to this project will be documented in this file. --- +## [2.0.0-beta.3](https://github.com/ReactiveX/RxSwift/releases/tag/2.0.0-beta.3) + +### Updated + +* Improves KVO mechanism. + * Type of observed object is now argument `view.rx_observe(CGRect.self, "frame")` + * Support for observing ObjC bridged enums and `RawRepresentable` protocol + * Support for easier extending of KVO using `KVORepresentable` protocol + * Deprecates KVO extensions that don't accept type as first argument in favor of ones that do. +* Adds `flatMapLatest` (also added to `Driver` unit). +* Adds `flatMapFirst` operator (also added to `Driver` unit). +* Adds `retryWhen` operator. +* Adds `window` operator. +* Adds `single` operator. +* Adds `single` (blocking version) operator. +* Adds `rx_primaryAction` on `UIButton` for `tvOS`. +* Transforms error types in `RxSwift`/`RxCocoa` projects from `NSError`s to Swift enum types. + * `RxError` + * `RxCocoaError` + * `RxCocoaURLError` + * ... +* Optimizes consecutive map operators. For example `map(validate1).map(validate2).map(parse)` is now internally optimized to one `map` operator. +* Adds scheduler overloads for `just`, `sequenceOf`, `toObservable`. +* Deprecates `asObservable` on `SequenceType` in favor of `toObservable`. +* Adds special overload of `toObservable` for `Array`. +* Improves table view animated data source example. +* Polishes `RxDataSourceStarterKit`, adds `differentiateForSectionedView` operator, `rx_itemsAnimatedWithDataSource` extension. +* Makes blocking operators run current thread runloop while blocking and thus disabling deadlocks. + +### Fixed + +* Fixes example with `Variable` in playgrounds so it less confusing regarding memory management. +* Fixes `UIImageView` extensions to use `UIImage?` instead of `UIImage!`. +* Changes improper usage of `CustomStringConvertible` with `CustomDebugStringConvertible`. + ## [2.0.0-beta.2](https://github.com/ReactiveX/RxSwift/releases/tag/2.0.0-beta.2) #### Updated diff --git a/Documentation/API.md b/Documentation/API.md index a35f98c9..93193934 100644 --- a/Documentation/API.md +++ b/Documentation/API.md @@ -26,20 +26,24 @@ Operators are stateless by default. * [`timer`](http://reactivex.io/documentation/operators/timer.html) #### Transforming Observables - * [`flatMap`](http://reactivex.io/documentation/operators/flatmap.html) - * [`map` / `select`](http://reactivex.io/documentation/operators/map.html) - * [`scan`](http://reactivex.io/documentation/operators/scan.html) * [`buffer`](http://reactivex.io/documentation/operators/buffer.html) + * [`flatMap`](http://reactivex.io/documentation/operators/flatmap.html) + * [`flatMapFirst`](http://reactivex.io/documentation/operators/flatmap.html) + * [`flatMapLatest`](http://reactivex.io/documentation/operators/flatmap.html) + * [`map`](http://reactivex.io/documentation/operators/map.html) + * [`scan`](http://reactivex.io/documentation/operators/scan.html) + * [`window`](http://reactivex.io/documentation/operators/window.html) #### Filtering Observables * [`debounce` / `throttle`](http://reactivex.io/documentation/operators/debounce.html) * [`distinctUntilChanged`](http://reactivex.io/documentation/operators/distinct.html) * [`elementAt`](http://reactivex.io/documentation/operators/elementat.html) - * [`filter` / `where`](http://reactivex.io/documentation/operators/filter.html) + * [`filter`](http://reactivex.io/documentation/operators/filter.html) * [`sample`](http://reactivex.io/documentation/operators/sample.html) * [`skip`](http://reactivex.io/documentation/operators/skip.html) * [`take`](http://reactivex.io/documentation/operators/take.html) * [`takeLast`](http://reactivex.io/documentation/operators/takelast.html) + * [`single`](http://reactivex.io/documentation/operators/first.html) #### Combining Observables @@ -53,6 +57,7 @@ Operators are stateless by default. * [`catch`](http://reactivex.io/documentation/operators/catch.html) * [`retry`](http://reactivex.io/documentation/operators/retry.html) + * [`retryWhen`](http://reactivex.io/documentation/operators/retry.html) #### Observable Utility Operators