Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.09 KB

README.md

File metadata and controls

77 lines (50 loc) · 2.09 KB

[WIP] We'll hold on an official release as we convert the lib to the new fine grained notifications from Realm.

RxRealm

Version License Platform

Usage

This library is a very thin wrapper around the reactive classes RealmSwift provides: Results, List and AnyRealmCollection.

The extension adds two methods to all of the above classes:

asObservable()

asObservable() - emits every time the collection changes:

let realm = try! Realm()
realm.objects(Lap).asObservable()
  .map {laps in "\(laps.count) laps"}
  .subscribeNext { text  in
    print(text)
  }

asObservableArray()

asObservableArray() - fetches the a snapshot of a Realm collection and converts it to an array value (for example if you want to use array methods on the collection):

let realm = try! Realm()
realm.objects(Lap).asObservableArray()
  .map {array in
    return array.prefix(3) //slice of first 3 items
  }
  .subscribeNext { text  in
    print(text)
  }

Example app

To run the example project, clone the repo, and run pod install from the Example directory first. The app uses RxSwift, RxCocoa using RealmSwift, RxRealm to observe Results from Realm.

Requirements

This library depends on both RxSwift and RealmSwift.

Installation

CocoaPods

RxRealm is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "RxRealm"

Carthage

Coming soon (feel free to send a PR)

Source

You can grab the RxRealm.swift file from this repo and include it in your project.

Author

This library belongs to RxSwiftCommunity and is based on the work of @fpillet

TODO

  • Carthage

License

RxRealm is available under the MIT license. See the LICENSE file for more info.