typeorm 1.0.0-beta.1 → 1.0.0-beta.2

package/browser/repository/MongoRepository.d.ts

@@ -19,6 +19,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     /**
      * Raw SQL query execution is not supported by MongoDB.
      * Calling this method will return an error.
+     *
      * @param query
      * @param parameters
      */
@@ -26,17 +27,20 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     /**
      * Using Query Builder with MongoDB is not supported yet.
      * Calling this method will return an error.
+     *
      * @param alias
      * @param queryRunner
      */
     createQueryBuilder(alias: string, queryRunner?: QueryRunner): SelectQueryBuilder<Entity>;
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param options
      */
     find(options?: FindManyOptions<Entity> | Partial<Entity> | FilterOperators<Entity>): Promise<Entity[]>;
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param where
      */
     findBy(where: any): Promise<Entity[]>;
@@ -44,6 +48,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
      * Finds entities that match given find options or conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param options
      */
     findAndCount(options?: MongoFindManyOptions<Entity>): Promise<[Entity[], number]>;
@@ -51,51 +56,60 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
      * Finds entities that match given find options or conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param where
      */
     findAndCountBy(where: any): Promise<[Entity[], number]>;
     /**
      * Finds entities by ids.
      * Optionally find options can be applied.
+     *
      * @param ids
      * @param options
      */
     findByIds(ids: any[], options?: any): Promise<Entity[]>;
     /**
      * Finds first entity that matches given find options.
+     *
      * @param options
      */
     findOne(options: MongoFindOneOptions<Entity>): Promise<Entity | null>;
     /**
      * Finds first entity that matches given WHERE conditions.
+     *
      * @param where
      */
     findOneBy(where: any): Promise<Entity | null>;
     /**
      * Finds first entity by a given find options.
      * If entity was not found in the database - rejects with error.
+     *
      * @param options
      */
     findOneOrFail(options: FindOneOptions<Entity>): Promise<Entity>;
     /**
      * Finds first entity that matches given where condition.
      * If entity was not found in the database - rejects with error.
+     *
      * @param where
      */
     findOneByOrFail(where: any): Promise<Entity>;
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
+     *
      * @param query
      */
     createCursor<T = any>(query?: Filter<Entity>): FindCursor<T>;
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param query
      */
     createEntityCursor(query?: Filter<Entity>): FindCursor<Entity>;
     /**
      * Execute an aggregation framework pipeline against the collection.
+     *
      * @param pipeline
      * @param options
      */
@@ -103,36 +117,42 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     /**
      * Execute an aggregation framework pipeline against the collection.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param pipeline
      * @param options
      */
     aggregateEntity(pipeline: ObjectLiteral[], options?: AggregateOptions): AggregationCursor<Entity>;
     /**
      * Perform a bulkWrite operation without a fluent API.
+     *
      * @param operations
      * @param options
      */
     bulkWrite(operations: AnyBulkWriteOperation[], options?: BulkWriteOptions): Promise<BulkWriteResult>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
     count(query?: ObjectLiteral, options?: CountOptions): Promise<number>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
     countDocuments(query?: ObjectLiteral, options?: CountDocumentsOptions): Promise<number>;
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
     countBy(query?: ObjectLiteral, options?: CountOptions): Promise<number>;
     /**
      * Creates an index on the db and collection.
+     *
      * @param fieldOrSpec
      * @param options
      */
@@ -141,23 +161,27 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
      * Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher.
      * Earlier version of MongoDB will throw a command not supported error.
      * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.
+     *
      * @param indexSpecs
      */
     createCollectionIndexes(indexSpecs: IndexDescription[]): Promise<string[]>;
     /**
      * Delete multiple documents on MongoDB.
+     *
      * @param query
      * @param options
      */
     deleteMany(query: ObjectLiteral, options?: DeleteOptions): Promise<DeleteResult>;
     /**
      * Delete a document on MongoDB.
+     *
      * @param query
      * @param options
      */
     deleteOne(query: ObjectLiteral, options?: DeleteOptions): Promise<DeleteResult>;
     /**
      * The distinct command returns returns a list of distinct values for the given key across a collection.
+     *
      * @param key
      * @param query
      * @param options
@@ -165,6 +189,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     distinct(key: string, query: ObjectLiteral, options?: CommandOperationOptions): Promise<any>;
     /**
      * Drops an index from this collection.
+     *
      * @param indexName
      * @param options
      */
@@ -175,12 +200,14 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     dropCollectionIndexes(): Promise<any>;
     /**
      * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param options
      */
     findOneAndDelete(query: ObjectLiteral, options?: FindOneAndDeleteOptions): Promise<Document | null>;
     /**
      * Find a document and replace it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param replacement
      * @param options
@@ -188,6 +215,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     findOneAndReplace(query: ObjectLiteral, replacement: Object, options?: FindOneAndReplaceOptions): Promise<Document | null>;
     /**
      * Find a document and update it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param update
      * @param options
@@ -199,11 +227,13 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     collectionIndexes(): Promise<any>;
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param indexes
      */
     collectionIndexExists(indexes: string | string[]): Promise<boolean>;
     /**
      * Retrieves this collections index info.
+     *
      * @param options
      * @param options.full
      */
@@ -212,22 +242,26 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     }): Promise<any>;
     /**
      * Initiate an In order bulk write operation, operations will be serially executed in the order they are added, creating a new operation for each switch in types.
+     *
      * @param options
      */
     initializeOrderedBulkOp(options?: BulkWriteOptions): OrderedBulkOperation;
     /**
      * Initiate a Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
+     *
      * @param options
      */
     initializeUnorderedBulkOp(options?: BulkWriteOptions): UnorderedBulkOperation;
     /**
      * Inserts an array of documents into MongoDB.
+     *
      * @param docs
      * @param options
      */
     insertMany(docs: ObjectLiteral[], options?: BulkWriteOptions): Promise<InsertManyResult<Document>>;
     /**
      * Inserts a single document into MongoDB.
+     *
      * @param doc
      * @param options
      */
@@ -238,11 +272,13 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     isCapped(): Promise<any>;
     /**
      * Get the list of all indexes information for the collection.
+     *
      * @param options
      */
     listCollectionIndexes(options?: ListIndexesOptions): ListIndexesCursor;
     /**
      * Reindex all indexes on the collection Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections.
+     *
      * @param newName
      * @param options
      * @param options.dropTarget
@@ -252,6 +288,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     }): Promise<Collection<Document>>;
     /**
      * Replace a document on MongoDB.
+     *
      * @param query
      * @param doc
      * @param options
@@ -259,6 +296,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     replaceOne(query: ObjectLiteral, doc: ObjectLiteral, options?: ReplaceOptions): Promise<Document | UpdateResult>;
     /**
      * Update multiple documents on MongoDB.
+     *
      * @param query
      * @param update
      * @param options
@@ -266,6 +304,7 @@ export declare class MongoRepository<Entity extends ObjectLiteral> extends Repos
     updateMany(query: ObjectLiteral, update: UpdateFilter<Document>, options?: UpdateOptions): Promise<Document | UpdateResult>;
     /**
      * Update a single document on MongoDB.
+     *
      * @param query
      * @param update
      * @param options

package/browser/repository/MongoRepository.js

@@ -13,6 +13,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Raw SQL query execution is not supported by MongoDB.
      * Calling this method will return an error.
+     *
      * @param query
      * @param parameters
      */
@@ -22,6 +23,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Using Query Builder with MongoDB is not supported yet.
      * Calling this method will return an error.
+     *
      * @param alias
      * @param queryRunner
      */
@@ -30,6 +32,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param options
      */
     find(options) {
@@ -37,6 +40,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Finds entities that match given find options or conditions.
+     *
      * @param where
      */
     findBy(where) {
@@ -46,6 +50,7 @@ class MongoRepository extends Repository_1.Repository {
      * Finds entities that match given find options or conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param options
      */
     findAndCount(options) {
@@ -55,6 +60,7 @@ class MongoRepository extends Repository_1.Repository {
      * Finds entities that match given find options or conditions.
      * Also counts all entities that match given conditions,
      * but ignores pagination settings (from and take options).
+     *
      * @param where
      */
     findAndCountBy(where) {
@@ -63,6 +69,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Finds entities by ids.
      * Optionally find options can be applied.
+     *
      * @param ids
      * @param options
      */
@@ -71,6 +78,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Finds first entity that matches given find options.
+     *
      * @param options
      */
     async findOne(options) {
@@ -78,6 +86,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Finds first entity that matches given WHERE conditions.
+     *
      * @param where
      */
     async findOneBy(where) {
@@ -86,6 +95,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Finds first entity by a given find options.
      * If entity was not found in the database - rejects with error.
+     *
      * @param options
      */
     async findOneOrFail(options) {
@@ -94,6 +104,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Finds first entity that matches given where condition.
      * If entity was not found in the database - rejects with error.
+     *
      * @param where
      */
     async findOneByOrFail(where) {
@@ -101,6 +112,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
+     *
      * @param query
      */
     createCursor(query) {
@@ -109,6 +121,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Creates a cursor for a query that can be used to iterate over results from MongoDB.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param query
      */
     createEntityCursor(query) {
@@ -116,6 +129,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Execute an aggregation framework pipeline against the collection.
+     *
      * @param pipeline
      * @param options
      */
@@ -125,6 +139,7 @@ class MongoRepository extends Repository_1.Repository {
     /**
      * Execute an aggregation framework pipeline against the collection.
      * This returns modified version of cursor that transforms each result into Entity model.
+     *
      * @param pipeline
      * @param options
      */
@@ -133,6 +148,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Perform a bulkWrite operation without a fluent API.
+     *
      * @param operations
      * @param options
      */
@@ -141,22 +157,25 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
     count(query, options) {
-        return this.manager.count(this.metadata.target, query || {}, options);
+        return this.manager.count(this.metadata.target, query ?? {}, options);
     }
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
     countDocuments(query, options) {
-        return this.manager.countDocuments(this.metadata.target, query || {}, options);
+        return this.manager.countDocuments(this.metadata.target, query ?? {}, options);
     }
     /**
      * Count number of matching documents in the db to a query.
+     *
      * @param query
      * @param options
      */
@@ -165,6 +184,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Creates an index on the db and collection.
+     *
      * @param fieldOrSpec
      * @param options
      */
@@ -175,6 +195,7 @@ class MongoRepository extends Repository_1.Repository {
      * Creates multiple indexes in the collection, this method is only supported for MongoDB 2.6 or higher.
      * Earlier version of MongoDB will throw a command not supported error.
      * Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.
+     *
      * @param indexSpecs
      */
     createCollectionIndexes(indexSpecs) {
@@ -182,6 +203,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Delete multiple documents on MongoDB.
+     *
      * @param query
      * @param options
      */
@@ -190,6 +212,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Delete a document on MongoDB.
+     *
      * @param query
      * @param options
      */
@@ -198,6 +221,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * The distinct command returns returns a list of distinct values for the given key across a collection.
+     *
      * @param key
      * @param query
      * @param options
@@ -207,6 +231,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Drops an index from this collection.
+     *
      * @param indexName
      * @param options
      */
@@ -221,6 +246,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Find a document and delete it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param options
      */
@@ -229,6 +255,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Find a document and replace it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param replacement
      * @param options
@@ -238,6 +265,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Find a document and update it in one atomic operation, requires a write lock for the duration of the operation.
+     *
      * @param query
      * @param update
      * @param options
@@ -253,6 +281,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Retrieve all the indexes on the collection.
+     *
      * @param indexes
      */
     collectionIndexExists(indexes) {
@@ -260,6 +289,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Retrieves this collections index info.
+     *
      * @param options
      * @param options.full
      */
@@ -268,6 +298,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Initiate an In order bulk write operation, operations will be serially executed in the order they are added, creating a new operation for each switch in types.
+     *
      * @param options
      */
     initializeOrderedBulkOp(options) {
@@ -275,6 +306,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Initiate a Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
+     *
      * @param options
      */
     initializeUnorderedBulkOp(options) {
@@ -282,6 +314,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Inserts an array of documents into MongoDB.
+     *
      * @param docs
      * @param options
      */
@@ -290,6 +323,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Inserts a single document into MongoDB.
+     *
      * @param doc
      * @param options
      */
@@ -304,6 +338,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Get the list of all indexes information for the collection.
+     *
      * @param options
      */
     listCollectionIndexes(options) {
@@ -311,6 +346,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Reindex all indexes on the collection Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) and will be slow for large collections.
+     *
      * @param newName
      * @param options
      * @param options.dropTarget
@@ -320,6 +356,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Replace a document on MongoDB.
+     *
      * @param query
      * @param doc
      * @param options
@@ -329,6 +366,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Update multiple documents on MongoDB.
+     *
      * @param query
      * @param update
      * @param options
@@ -338,6 +376,7 @@ class MongoRepository extends Repository_1.Repository {
     }
     /**
      * Update a single document on MongoDB.
+     *
      * @param query
      * @param update
      * @param options