RxSwift - API

RxSwift 支持的操作符

在某些情况,由于不同平台/实现方式,相同的操作符有多个别名,有时相同的操作命名也不一样,有些是因为历史的原因,但是还有一些是因为语言的预留关键字。

当缺少社区共识的时候,RxSwift 通常会包含多个别名。

默认情况下,操作符是没有状态的。

创建 Observable

  • asObservable
  • create
  • deferred
  • empty
  • error
  • toObservable (array)
  • interval
  • never
  • just
  • of
  • range
  • repeatElement
  • timer

变换 Observable

  • buffer
  • flatMap
  • flatMapFirst
  • flatMapLatest
  • map
  • scan
  • window

过滤 Observable

  • debounce / throttle
  • distinctUntilChanged`
  • elementAt
  • filter
  • sample
  • skip
  • take
  • takeLast
  • single

联合 Observable

  • merge
  • startWith
  • switchLatest
  • combineLatest
  • zip

错误处理操作符

  • catch
  • retry
  • retryWhen

Observable Utility Operators

  • delaySubscription
  • do / doOnNext
  • observeOn / observeSingleOn
  • subscribe
  • subscribeOn
  • timeout
  • using
  • debug

条件和 Bool 操作符

  • amb
  • skipWhile
  • skipUntil
  • takeUntil
  • takeWhile

数学和聚合操作符

  • concat
  • reduce / aggregate
  • toArray

连接 Observable 操作符

  • multicast
  • publish
  • refCount
  • replay
  • shareReplay
    创建新的操作符也是相当简单的。

RxCocoa 扩展

iOS / OSX


extension NSObject {

    public var rx_deallocated: Observable {}

#if !DISABLE_SWIZZLING

    public var rx_deallocating: Observable {}

#endif

}

extension NSObject {

    public func rx_observe(
        type: E.Type,
        _ keyPath: String,
        options: NSKeyValueObservingOptions = .New | .Initial,
        retainSelf: Bool = true
    )  -> Observable {}

#if !DISABLE_SWIZZLING

    public func rx_observeWeakly(
        type: E.Type,
        _ keyPath: String,
        options: NSKeyValueObservingOptions = .New | .Initial
    ) -> Observable {}

#endif
}
extension NSURLSession {

    public func rx_response(request: NSURLRequest) -> Observable<(NSData, NSURLResponse)> {}

    public func rx_data(request: NSURLRequest) -> Observable {}

    public func rx_JSON(request: NSURLRequest) -> Observable {}

    public func rx_JSON(URL: NSURL) -> Observable {}

}
extension NSNotificationCenter {

    public func rx_notification(name: String, object: AnyObject?) -> Observable {}

}
class DelegateProxy {

    public func observe(selector: Selector) -> Observable<[AnyObject]> {}

}
extension CLLocationManager {

    public var rx_delegate: DelegateProxy {}

    public var rx_didUpdateLocations: Observable<[CLLocation]> {}

    public var rx_didFailWithError: Observable {}

    public var rx_didFinishDeferredUpdatesWithError: Observable {}

    public var rx_didPauseLocationUpdates: Observable {}

    public var rx_didResumeLocationUpdates: Observable {}

    public var rx_didUpdateHeading: Observable {}

    public var rx_didEnterRegion: Observable {}

    public var rx_didExitRegion: Observable {}

    public var rx_didDetermineStateForRegion: Observable<(state: CLRegionState, region: CLRegion)> {}

    public var rx_monitoringDidFailForRegionWithError: Observable<(region: CLRegion?, error: NSError)> {}

    public var rx_didStartMonitoringForRegion: Observable {}

    public var rx_didRangeBeaconsInRegion: Observable<(beacons: [CLBeacon], region: CLBeaconRegion)> {}

    public var rx_rangingBeaconsDidFailForRegionWithError: Observable<(region: CLBeaconRegion, error: NSError)> {}

    public var rx_didVisit: Observable {}

    public var rx_didChangeAuthorizationStatus: Observable {}

}

iOS


extension UIControl {

    public func rx_controlEvent(controlEvents: UIControlEvents) -> ControlEvent {}

    public var rx_enabled: ObserverOf {}
}

extension UIButton {

    public var rx_tap: ControlEvent {}

}
extension UITextField {

    public var rx_text: ControlProperty {}

}
extension UITextView {

    override func rx_createDelegateProxy() -> RxScrollViewDelegateProxy {}

    public var rx_text: ControlProperty {}

}
extension UISearchBar {

    public var rx_delegate: DelegateProxy {}

    public var rx_searchText: ControlProperty {}

}
extension UILabel {

    public var rx_text: ObserverOf {}

}
extension UIDatePicker {

    public var rx_date: ControlProperty {}

}
extension UIImageView {

    public var rx_image: ObserverOf {}

    public func rx_imageAnimated(transitionType: String?) -> AnyObserver

}
extension UIScrollView {

    public var rx_delegate: DelegateProxy {}

    public func rx_setDelegate(delegate: UIScrollViewDelegate) {}

    public var rx_contentOffset: ControlProperty {}

}
extension UIBarButtonItem {

    public var rx_tap: ControlEvent {}

}
extension UISlider {

    public var rx_value: ControlProperty {}

}
extension UITableView {

    public var rx_dataSource: DelegateProxy {}

    public func rx_setDataSource(dataSource: UITableViewDataSource) -> Disposable {}

    public func rx_itemsWithCellFactory(source: O)(cellFactory: (UITableView, Int, S.Generator.Element) -> UITableViewCell) -> Disposable {}

    public func rx_itemsWithCellIdentifier(cellIdentifier: String, cellType: Cell.Type = Cell.self)(source: O)(configureCell: (Int, S.Generator.Element, Cell) -> Void) -> Disposable {}

    public func rx_itemsWithDataSource(dataSource: DataSource)(source: O) -> Disposable {}

    public var rx_itemSelected: ControlEvent {}

    public var rx_itemDeselected: ControlEvent {}

    public var rx_itemInserted: ControlEvent {}

    public var rx_itemDeleted: ControlEvent {}

    public var rx_itemMoved: ControlEvent {}

    // This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
    public func rx_modelSelected(modelType: T.Type) -> ControlEvent {}

    // This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
    public func rx_modelDeselected(modelType: T.Type) -> ControlEvent {}

}
extension UICollectionView {

    public var rx_dataSource: DelegateProxy {}

    public func rx_setDataSource(dataSource: UICollectionViewDataSource) -> Disposable {}

    public func rx_itemsWithCellFactory(source: O)(cellFactory: (UICollectionView, Int, S.Generator.Element) -> UICollectionViewCell) -> Disposable {}

    public func rx_itemsWithCellIdentifier(cellIdentifier: String, cellType: Cell.Type = Cell.self)(source: O)(configureCell: (Int, S.Generator.Element, Cell) -> Void) -> Disposable {}

    public func rx_itemsWithDataSource(dataSource: DataSource)(source: O) -> Disposable {}

    public var rx_itemSelected: ControlEvent {}

    public var rx_itemDeselected: ControlEvent {}

    // This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
    public func rx_modelSelected(modelType: T.Type) -> ControlEvent {}

    // This method only works in case one of the `rx_itemsWith*` methods was used, or data source implements `SectionedViewDataSourceType`
    public func rx_modelSelected(modelType: T.Type) -> ControlEvent {}
}
extension UIGestureRecognizer {

    public var rx_event: ControlEvent {}

}
extension UIImagePickerController {

    public var rx_didFinishPickingMediaWithInfo: Observable<[String : AnyObject]> {}

    public var rx_didCancel: Observable<()> {}

}
extension UISegmentedControl {

    public var rx_value: ControlProperty {}

}
extension UISwitch {

    public var rx_value: ControlProperty {}

}
extension UIActivityIndicatorView {

    public var rx_animating: AnyObserver {}

}
extension UINavigationItem {

    public var rx_title: AnyObserver {}
}

OSX

extension NSControl {

    public var rx_controlEvent: ControlEvent<()> {}

    public var rx_enabled: AnyObserver {}

}

extension NSSlider {

    public var rx_value: ControlProperty {}

}
extension NSButton {

    public var rx_tap: ControlEvent {}

    public var rx_state: ControlProperty {}

}
extension NSImageView {

    public var rx_image: ObserverOf {}

    public func rx_imageAnimated(transitionType: String?) -> AnyObserver
}
extension NSTextField {

    public var rx_delegate: DelegateProxy {}

    public var rx_text: ControlProperty {}

}
extension UITabBarItem {

    public var rx_badgeValue: AnyObserver {}

}
extension UITabBar {

    public var rx_didSelectItem: ControlEvent {}

    public var rx_willBeginCustomizing: ControlEvent<[UITabBarItem]> {}

    public var rx_didBeginCustomizing: ControlEvent<[UITabBarItem]> {}

    public var rx_willEndCustomizing: ControlEvent<(items: [UITabBarItem], changed: Bool)> {}

    public var rx_didEndCustomizing: ControlEvent<(items: [UITabBarItem], changed: Bool)> {}

}

你可能感兴趣的:(RxSwift - API)