bugfix(types): Fixes array type of Observable in find()

Urigo · Nov 3, 2016 · 7a3f0f5 · 7a3f0f5
1 parent 3802b70
commit 7a3f0f5
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/dist/ObservableCollection.d.ts b/dist/ObservableCollection.d.ts
@@ -135,7 +135,7 @@ export declare module MongoObservable {
          *
          *  @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
          *  @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
-         *  @returns {ObservableCursor<T[]>} RxJS Observable wrapped with Meteor features.
+         *  @returns {ObservableCursor<T>} RxJS Observable wrapped with Meteor features.
          *  @example <caption>Using Angular2 Component</caption>
          *  const MyCollection = MongoObservable.Collection("myCollection");
          *
@@ -156,7 +156,7 @@ export declare module MongoObservable {
             fields?: FieldSpecifier;
             reactive?: boolean;
             transform?: Function;
-        }): ObservableCursor<T[]>;
+        }): ObservableCursor<T>;
         /**
          *  Finds the first document that matches the selector, as ordered by sort and skip options.
          *

diff --git a/dist/ObservableCollection.js b/dist/ObservableCollection.js
@@ -182,7 +182,7 @@ export var MongoObservable;
          *
          *  @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
          *  @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
-         *  @returns {ObservableCursor<T[]>} RxJS Observable wrapped with Meteor features.
+         *  @returns {ObservableCursor<T>} RxJS Observable wrapped with Meteor features.
          *  @example <caption>Using Angular2 Component</caption>
          *  const MyCollection = MongoObservable.Collection("myCollection");
          *

diff --git a/dist/bundles/index.umd.js b/dist/bundles/index.umd.js
@@ -397,7 +397,7 @@ var ObservableCursor = (function (_super) {
          *
          *  @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
          *  @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
-         *  @returns {ObservableCursor<T[]>} RxJS Observable wrapped with Meteor features.
+         *  @returns {ObservableCursor<T>} RxJS Observable wrapped with Meteor features.
          *  @example <caption>Using Angular2 Component</caption>
          *  const MyCollection = MongoObservable.Collection("myCollection");
          *

diff --git a/docs/ObservableCollection.md b/docs/ObservableCollection.md
@@ -22,7 +22,7 @@ T is a generic type - should be used with the type of the objects inside the col
         * [.remove(selector)](#Collection+remove) ⇒ <code>Observable.&lt;Number&gt;</code>
         * [.update(selector, modifier, options)](#Collection+update) ⇒ <code>Observable.&lt;Number&gt;</code>
         * [.upsert(selector, modifier, options)](#Collection+upsert) ⇒ <code>Observable.&lt;{numberAffected, insertedId}&gt;</code>
-        * [.find(selector, options)](#Collection+find) ⇒ <code>ObservableCursor.&lt;Array.&lt;T&gt;&gt;</code>
+        * [.find(selector, options)](#Collection+find) ⇒ <code>ObservableCursor.&lt;T&gt;</code>
         * [.findOne(selector, options)](#Collection+findOne) ⇒ <code>any</code>
     * _inner_
         * [~MongoQueryOptions](#Collection..MongoQueryOptions) : <code>Object</code>
@@ -137,11 +137,11 @@ Finds the first document that matches the selector, as ordered by sort and skip
 
 <a name="Collection+find"></a>
 
-### collection.find(selector, options) ⇒ <code>ObservableCursor.&lt;Array.&lt;T&gt;&gt;</code>
+### collection.find(selector, options) ⇒ <code>ObservableCursor.&lt;T&gt;</code>
 Method has the same notation as Mongo.Collection.find, only returns Observable.
 
 **Kind**: instance method of <code>[Collection](#Collection)</code>  
-**Returns**: <code>ObservableCursor.&lt;Array.&lt;T&gt;&gt;</code> - RxJS Observable wrapped with Meteor features.  
+**Returns**: <code>ObservableCursor.&lt;T&gt;</code> - RxJS Observable wrapped with Meteor features.  
 **See**: [find on Meteor documentation](https://docs.meteor.com/api/collections.html#Mongo-Collection-find)  
 
 | Param | Type | Description |

diff --git a/src/ObservableCollection.ts b/src/ObservableCollection.ts
@@ -228,7 +228,7 @@ export module MongoObservable {
      *
      *  @param {Collection~MongoQuerySelector} selector - A query describing the documents to find
      *  @param {Collection~MongoQueryOptions} options - Query options, such as sort, limit, etc.
-     *  @returns {ObservableCursor<T[]>} RxJS Observable wrapped with Meteor features.
+     *  @returns {ObservableCursor<T>} RxJS Observable wrapped with Meteor features.
      *  @example <caption>Using Angular2 Component</caption>
      *  const MyCollection = MongoObservable.Collection("myCollection");
      *
@@ -249,10 +249,10 @@ export module MongoObservable {
       fields?: FieldSpecifier;
       reactive?: boolean;
       transform?: Function;
-    }): ObservableCursor<T[]> {
+    }): ObservableCursor<T> {
       const cursor = this._collection.find.apply(
         this._collection, arguments);
-      return ObservableCursor.create<T[]>(cursor);
+      return ObservableCursor.create<T>(cursor);
     }
 
     /**