Skip to content

Commit

Permalink
Update incorrect parameter name
Browse files Browse the repository at this point in the history
`synchronizedStart` really is `synchronousStart` in the current implementation
  • Loading branch information
fpillet authored Oct 21, 2017
1 parent 32cdef4 commit a3196a6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This library is a thin wrapper around __RealmSwift__ ( [Realm Docs](https://real

RxRealm can be used to create `Observable`s from objects of type `Results`, `List`, `LinkingObjects` or `AnyRealmCollection`. These types are typically used to load and observe object collections from the Realm Mobile Database.

##### `Observable.collection(from:synchronizedStart:)`
##### `Observable.collection(from:synchronousStart:)`
Emits an event each time the collection changes:

```swift
Expand All @@ -35,9 +35,9 @@ Observable.collection(from: laps)
})
```

The above prints out "X laps" each time a lap is added or removed from the database. If you set `synchronizedStart` to `true` (the default value), the first element will be emitted synchronously - e.g. when you're binding UI you might not be able for an asynchronous notification to come through.
The above prints out "X laps" each time a lap is added or removed from the database. If you set `synchronousStart` to `true` (the default value), the first element will be emitted synchronously - e.g. when you're binding UI you might not be able for an asynchronous notification to come through.

##### `Observable.array(from:synchronizedStart:)`
##### `Observable.array(from:synchronousStart:)`
Upon each change fetches a snapshot of the Realm collection and converts it to an array value (for example if you want to use array methods on the collection):

```swift
Expand All @@ -53,7 +53,7 @@ Observable.array(from: laps)
})
```

##### `Observable.changeset(from:synchronizedStart:)`
##### `Observable.changeset(from:synchronousStart:)`
Emits every time the collection changes and provides the exact indexes that has been deleted, inserted or updated:

```swift
Expand All @@ -75,7 +75,7 @@ Observable.changeset(from: laps)
})
```

##### `Observable.arrayWithChangeset(from:synchronizedStart:)`
##### `Observable.arrayWithChangeset(from:synchronousStart:)`
Combines the result of `Observable.array(from:)` and `Observable.changeset(from:)` returning an `Observable<Array<T>, RealmChangeset?>`

```swift
Expand Down

0 comments on commit a3196a6

Please sign in to comment.