/
typings.ts
6136 lines (5215 loc) · 191 KB
/
typings.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { EventEmitter, Readable, Writable } from "../../platform/PlatformTools";
/**
* Creates a new MongoClient instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/MongoClient.html
*/
export declare class MongoClient extends EventEmitter {
constructor(uri: string, options?: MongoClientOptions);
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param callback The command result callback.
*/
static connect(url: string, callback: MongoCallback<Db>): void;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param options Optional settings.
*/
static connect(url: string, options?: MongoClientOptions): Promise<Db>;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param options Optional settings.
* @param callback The command result callback.
*/
static connect(url: string, options: MongoClientOptions, callback: MongoCallback<Db>): void;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*/
connect(): Promise<MongoClient>;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param callback The command result callback.
*/
connect(url: string, callback: MongoCallback<Db>): void;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param options Optional settings.
*/
connect(url: string, options?: MongoClientOptions): Promise<Db>;
/**
* Connect to MongoDB using a url as documented at docs.mongodb.org/manual/reference/connection-string/
* Note that for replicasets the replicaSet query parameter is required in the 2.0 driver.
*
* @param url The connection URI string.
* @param options Optional settings.
* @param callback The command result callback.
*/
connect(url: string, options: MongoClientOptions, callback: MongoCallback<Db>): void;
/**
* Close the db and its underlying connections.
* @param callback The result callback.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#close
*/
close(callback: MongoCallback<void>): void;
/**
* Close the db and its underlying connections.
* @param force Force close, emitting no events.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#close
*/
close(force?: boolean): Promise<void>;
/**
* Close the db and its underlying connections.
* @param force Force close, emitting no events.
* @param callback The result callback.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#close
*/
close(force: boolean, callback: MongoCallback<void>): void;
/**
* Create a new Db instance sharing the current socket connections. Be aware that the new db instances are
* related in a parent-child relationship to the original instance so that events are correctly emitted on child
* db instances. Child db instances are cached so performing db('db1') twice will return the same instance.
* You can control these behaviors with the options noListener and returnNonCachedInstance.
* @param dbName The name of the database we want to use. If not provided, use database name from connection string.
* @param options Optional settings.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#db
*/
db(dbName?: string, options?: MongoClientCommonOption): Db;
/**
* Check if MongoClient is connected.
* @param options Optional settings.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#isConnected
*/
isConnected(options?: MongoClientCommonOption): boolean;
/**
* Logout user from server, fire off on all connections and remove all auth info.
* @param callback The result callback.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#logout
*/
logout(callback: MongoCallback<any>): void;
logout(options?: { dbName?: string }): Promise<any>;
logout(options: { dbName?: string }, callback: MongoCallback<any>): void;
/**
* Starts a new session on the server.
* @param options Optional settings.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#startSession
*/
startSession(options?: SessionOptions): ClientSession;
/**
* Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this cluster.
* Will ignore all changes to system collections, as well as the local, admin, and config databases.
* @param pipeline An array of aggregation pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
* @param options Optional settings.
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/Collection.html#watch
*/
watch(pipeline?: Object[], options?: ChangeStreamOptions & { startAtClusterTime?: Timestamp, session?: ClientSession }): ChangeStream;
/**
* Runs a given operation with an implicitly created session. The lifetime of the session will be handled without the need for user interaction.
* @param operation An operation to execute with an implicitly created session. The signature of this MUST be `(session) => {}`
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#withSession
*/
withSession(operation: (session: ClientSession) => Promise<any>): Promise<void>;
/**
* Runs a given operation with an implicitly created session. The lifetime of the session will be handled without the need for user interaction.
* @param options Optional settings to be appled to implicitly created session.
* @param operation An operation to execute with an implicitly created session. The signature of this MUST be `(session) => {}`
* @see http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html#withSession
*/
withSession(options: SessionOptions, operation: (session: ClientSession) => Promise<any>): Promise<void>;
}
/**
* The callback format for results.
*/
export interface MongoCallback<T> {
/**
* @param error An error instance representing the error during the execution.
* @param result The result of execution.
*/
(error: MongoError, result: T): void;
}
// http://mongodb.github.io/node-mongodb-native/2.1/api/MongoError.html
export declare class MongoError extends Error {
constructor(message: string);
static create(options: Object): MongoError;
}
/**
* Options for MongoClient#connect method.
*
* @see http://mongodb.github.io/node-mongodb-native/2.2/api/MongoClient.html#.connect
*/
export interface MongoClientOptions {
/**
* The maximum size of the individual server pool.
*/
poolSize?: number;
/**
* Enable SSL connection.
*/
ssl?: boolean;
/**
* SSL Certificate store binary buffer.
*/
sslCA?: Buffer;
/**
* Uri decode the user name and password for authentication.
*/
uri_decode_auth?: boolean;
/**
* A hash of options to set on the db object, see Db constructor.
*/
db?: DbCreateOptions;
/**
* A hash of options to set on the server objects, see Server constructor**.
*/
server?: ServerOptions;
/**
* A hash of options to set on the replSet object, see ReplSet constructor**.
*/
replSet?: ReplSetOptions;
/**
* A hash of options to set on the mongos object, see Mongos constructor**.
*/
mongos?: MongosOptions;
/**
* A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible.
*/
promiseLibrary?: Object;
}
export interface CommandOptions {
/**
* The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED,
* ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
*/
readPreference?: ReadPreference | string;
/**
* Number of milliseconds to wait before aborting the query.
*/
maxTimeMS?: number;
}
/**
* Options for Db class.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html
*/
export interface DbCreateOptions {
/**
* If the database authentication is dependent on another databaseName.
*/
authSource?: string;
/**
* The write concern.
*/
w?: number | string;
/**
* The write concern timeout.
*/
wtimeout?: number;
/**
* Specify a journal write concern.
*/
j?: boolean;
/**
* The current value of the parameter native_parser.
*/
native_parser?: boolean;
/**
* Force server to assign _id values instead of driver.
*/
forceServerObjectId?: boolean;
/**
* Serialize functions on any object.
*/
serializeFunctions?: boolean;
/**
* Specify if the BSON serializer should ignore undefined fields.
*/
ignoreUndefined?: boolean;
/**
* Return document results as raw BSON buffers.
*/
raw?: boolean;
/**
* Promotes Long values to number if they fit inside the 53 bits resolution.
*/
promoteLongs?: boolean;
/**
* Sets a cap on how many operations the driver will buffer up before giving up on getting a working connection, default is -1 which is unlimited.
*/
bufferMaxEntries?: number;
/**
* The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
*/
readPreference?: ReadPreference | string;
/**
* A primary key factory object for generation of custom _id keys.
*/
pkFactory?: Object;
/**
* A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible.
*/
promiseLibrary?: Object;
/**
* Specify a read concern for the collection. (only MongoDB 3.2 or higher supported).
*/
readConcern?: ReadConcern;
}
/**
* Creates a new ReadPreference instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/ReadPreference.html
*/
export declare class ReadPreference {
constructor(mode: string, tags: Object);
/**
* The ReadPreference mode as listed above.
*/
mode: string;
/**
* An object representing read preference tags.
*/
tags: any;
/**
* Read from primary only. All operations produce an error (throw an exception where applicable) if primary is unavailable. Cannot be combined with tags (This is the default.).
*/
static PRIMARY: string;
/**
* Read from primary if available, otherwise a secondary.
*/
static PRIMARY_PREFERRED: string;
/**
* Read from secondary if available, otherwise error.
*/
static SECONDARY: string;
/**
* Read from a secondary if available, otherwise read from the primary.
*/
static SECONDARY_PREFERRED: string;
/**
* All modes read from among the nearest candidates, but unlike other modes, NEAREST will include both the primary and all secondaries in the random selection.
*/
static NEAREST: string;
/**
* Validate if a mode is legal.
*/
isValid(mode: string): boolean;
/**
* Validate if a mode is legal.
*/
static isValid(mode: string): boolean;
}
/**
* Creates a new Server instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html
*/
export interface SocketOptions {
/**
* Reconnect on error.
*/
autoReconnect?: boolean;
/**
* TCP Socket NoDelay option.
*/
noDelay?: boolean;
/**
* TCP KeepAlive on the socket with a X ms delay before start.
*/
keepAlive?: number;
/**
* TCP Connection timeout setting.
*/
connectTimeoutMS?: number;
/**
* TCP Socket timeout setting.
*/
socketTimeoutMS?: number;
}
/**
* Creates a new Server instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html
*/
export interface ServerOptions {
/**
* Number of connections in the connection pool for each server instance, set to 5 as default for legacy reasons.
*/
poolSize?: number;
/**
* Use ssl connection (needs to have a mongod server with ssl support).
*/
ssl?: boolean;
/**
* Validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslValidate?: Object;
/**
* Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
*/
checkServerIdentity?: boolean | Function;
/**
* Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCA?: Array<Buffer | string>;
/**
* String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCert?: Buffer | string;
/**
* String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslKey?: Buffer | string;
/**
* String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslPass?: Buffer | string;
/**
* Socket options.
*/
socketOptions?: SocketOptions;
/**
* Server attempt to reconnect #times.
*/
reconnectTries?: number;
/**
* Server will wait # milliseconds between retries.
*/
reconnectInterval?: number;
}
/**
* Creates a new ReplSet instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/ReplSet.html
*/
export interface ReplSetOptions {
/**
* Turn on high availability monitoring.
*/
ha?: boolean;
/**
* Time between each replicaset status check.
*/
haInterval?: number;
/**
* The name of the replicaset to connect to.
*/
replicaSet?: string;
/**
* Sets the range of servers to pick when using NEAREST (lowest ping ms + the latency fence, ex: range of 1 to (1 + 15) ms).
*/
secondaryAcceptableLatencyMS?: number;
/**
* Sets if the driver should connect even if no primary is available.
*/
connectWithNoPrimary?: boolean;
/**
* Number of connections in the connection pool for each server instance, set to 5 as default for legacy reasons.
*/
poolSize?: number;
/**
* Use ssl connection (needs to have a mongod server with ssl support).
*/
ssl?: boolean;
/**
* Validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslValidate?: Object;
/**
* Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
*/
checkServerIdentity?: boolean | Function;
/**
* Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCA?: Array<Buffer | string>;
/**
* String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCert?: Buffer | string;
/**
* String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslKey?: Buffer | string;
/**
* String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslPass?: Buffer | string;
/**
* Socket options.
*/
socketOptions?: SocketOptions;
}
/**
* Creates a new Mongos instance.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Mongos.html
*/
export interface MongosOptions {
/**
* Turn on high availability monitoring.
*/
ha?: boolean;
/**
* Time between each replicaset status check.
*/
haInterval?: number;
/**
* Number of connections in the connection pool for each server instance, set to 5 as default for legacy reasons.
*/
poolSize?: number;
/**
* Use ssl connection (needs to have a mongod server with ssl support).
*/
ssl?: boolean;
/**
* Validate mongod server certificate against ca (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslValidate?: Object;
/**
* Ensure we check server identify during SSL, set to false to disable checking. Only works for Node 0.12.x or higher. You can pass in a boolean or your own checkServerIdentity override function.
*/
checkServerIdentity?: boolean | Function;
/**
* Array of valid certificates either as Buffers or Strings (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCA?: Array<Buffer | string>;
/**
* String or buffer containing the certificate we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslCert?: Buffer | string;
/**
* String or buffer containing the certificate private key we wish to present (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslKey?: Buffer | string;
/**
* String or buffer containing the certificate password (needs to have a mongod server with ssl support, 2.4 or higher).
*/
sslPass?: Buffer | string;
/**
* Socket options.
*/
socketOptions?: SocketOptions;
}
export interface DbOptions {
/**
* Do not make the db an event listener to the original connection.
*/
noListener?: boolean;
/**
* Control if you want to return a cached instance or have a new one created.
*/
returnNonCachedInstance?: boolean;
}
export interface IndexInformationOptions {
/**
* Returns the full raw index information.
*/
full?: boolean;
/**
* The preferred read preference (ReadPreference.PRIMARY,
* ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY,
* ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
*/
readPreference?: ReadPreference | string;
}
export interface ExecuteDbAdminCommandOptions {
/**
* The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED,
* ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
*/
readPreference?: ReadPreference | string;
// maxTimeMS?: number;
}
export interface ListCollectionsOptions {
/**
* The batchSize for the returned command cursor or if pre 2.8 the systems batch collection.
*/
batchSize?: number;
/**
* The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED,
* ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
*/
readPreference?: ReadPreference | string;
}
/**
* Db.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html
*/
export declare class Db extends EventEmitter {
/**
*
* @param databaseName The name of the database this instance represents.
* @param serverConfig The server topology for the database.
* @param options Optional.
*/
constructor(databaseName: string, serverConfig: Server | ReplSet | Mongos, options?: DbCreateOptions);
/**
* Get the current db topology.
*/
serverConfig: Server | ReplSet | Mongos;
/**
* Current bufferMaxEntries value for the database.
*/
bufferMaxEntries: number;
/**
* The name of the database this instance represents.
*/
databaseName: string;
/**
* The options associated with the db instance.
*/
options: any;
/**
* The current value of the parameter native_parser.
*/
native_parser: boolean;
/**
* The current slaveOk value for the db instance.
*/
slaveOk: boolean;
/**
* The current write concern values.
*/
writeConcern: WriteConcern;
/**
* Add a user to the database.
*
* @param username The username.
* @param password The password.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#addUser
*/
addUser(username: string, password: string, callback: MongoCallback<any>): void;
/**
* Add a user to the database.
*
* @param username The username.
* @param password The password.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#addUser
*/
addUser(username: string, password: string, options?: DbAddUserOptions): Promise<any>;
/**
* Add a user to the database.
*
* @param username The username.
* @param password The password.
* @param options Optional settings.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#addUser
*/
addUser(username: string, password: string, options: DbAddUserOptions, callback: MongoCallback<any>): void;
/**
* Return the Admin db instance.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#admin
*/
admin(): Admin;
/**
* Authenticate a user against the server.
*
* @param userName The username.
* @param password The password.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#authenticate
*/
authenticate(userName: string, password: string, callback: MongoCallback<any>): void;
/**
* Authenticate a user against the server.
*
* @param userName The username.
* @param password The password.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#authenticate
*/
authenticate(userName: string, password: string, options?: { authMechanism: string }): Promise<any>;
/**
* Authenticate a user against the server.
*
* @param userName The username.
* @param password The password.
* @param password
* @param options
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#authenticate
*/
authenticate(userName: string, password: string, options: { authMechanism: string }, callback: MongoCallback<any>): void;
/**
* Close the db and its underlying connections.
*
* @param callback The result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#close
*/
close(callback: MongoCallback<void>): void;
/**
* Close the db and its underlying connections.
*
* @param forceClose Force close, emitting no events.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#close
*/
close(forceClose?: boolean): Promise<void>;
/**
* Close the db and its underlying connections.
*
* @param forceClose Force close, emitting no events.
* @param callback The result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#close
*/
close(forceClose: boolean, callback: MongoCallback<void>): void;
/**
* Fetch a specific collection (containing the actual collection information). If the application does not use strict mode you can
* can use it without a callback in the following way: var collection = db.collection('mycollection');
*
* @param name The collection name we wish to access.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#collection
*/
collection(name: string): Collection<any>;
/**
* Fetch a specific collection (containing the actual collection information). If the application does not use strict mode you can
* can use it without a callback in the following way: var collection = db.collection('mycollection');
*
* @param name The collection name we wish to access.
* @param callback The collection result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#collection
*/
collection(name: string, callback: MongoCallback<Collection<any>>): Collection<any>;
/**
* Fetch a specific collection (containing the actual collection information). If the application does not use strict mode you can
* can use it without a callback in the following way: var collection = db.collection('mycollection');
*
* @param name The collection name we wish to access.
* @param options Optional settings.
* @param callback The collection result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#collection
*/
collection(name: string, options: DbCollectionOptions, callback: MongoCallback<Collection<any>>): Collection<any>;
/**
* Fetch all collections for the current db.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#collections
*/
collections(): Promise<Collection<any>[]>;
/**
* Fetch all collections for the current db.
*
* @param callback The results callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#collections
*/
collections(callback: MongoCallback<Collection<any>[]>): void;
/**
* Execute a command.
*
* @param command The command hash.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#command
*/
command(command: Object, callback: MongoCallback<any>): void;
/**
* Execute a command.
*
* @param command The command hash.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#command
*/
command(command: Object, options?: { readPreference: ReadPreference | string }): Promise<any>;
/**
* Execute a command.
*
* @param command The command hash.
* @param options Optional settings.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#command
*/
command(command: Object, options: { readPreference: ReadPreference | string }, callback: MongoCallback<any>): void;
/**
* Create a new collection on a server with the specified options. Use this to create capped collections.
*
* @param name The collection name we wish to access.
* @param callback The results callback
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createCollection
*/
createCollection(name: string, callback: MongoCallback<Collection<any>>): void;
/**
* Create a new collection on a server with the specified options. Use this to create capped collections.
*
* @param name The collection name we wish to access.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createCollection
*/
createCollection(name: string, options?: CollectionCreateOptions): Promise<Collection<any>>;
/**
* Create a new collection on a server with the specified options. Use this to create capped collections.
*
* @param name The collection name we wish to access.
* @param options Optional settings.
* @param callback The results callback
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createCollection
*/
createCollection(name: string, options: CollectionCreateOptions, callback: MongoCallback<Collection<any>>): void;
/**
* Creates an index on the db and collection collection.
*
* @param name Name of the collection to create the index on.
* @param fieldOrSpec Defines the index.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createIndex
*/
createIndex(name: string, fieldOrSpec: string | Object, callback: MongoCallback<any>): void;
/**
* Creates an index on the db and collection collection.
*
* @param name Name of the collection to create the index on.
* @param fieldOrSpec Defines the index.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createIndex
*/
createIndex(name: string, fieldOrSpec: string | Object, options?: MongodbIndexOptions): Promise<any>;
/**
* Creates an index on the db and collection collection.
*
* @param name Name of the collection to create the index on.
* @param fieldOrSpec Defines the index.
* @param options Optional settings.
* @param callback The command result callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#createIndex
*/
createIndex(name: string, fieldOrSpec: string | Object, options: MongodbIndexOptions, callback: MongoCallback<any>): void;
/**
* Create a new Db instance sharing the current socket connections. Be aware that the new db instances are
* related in a parent-child relationship to the original instance so that events are correctly emitted on child
* db instances. Child db instances are cached so performing db('db1') twice will return the same instance.
* You can control these behaviors with the options noListener and returnNonCachedInstance.
*
* @param dbName The name of the database we want to use.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#db
*/
db(dbName: string): Db;
/**
* Create a new Db instance sharing the current socket connections. Be aware that the new db instances are
* related in a parent-child relationship to the original instance so that events are correctly emitted on child
* db instances. Child db instances are cached so performing db('db1') twice will return the same instance.
* You can control these behaviors with the options noListener and returnNonCachedInstance.
*
* @param dbName The name of the database we want to use.
* @param options Optional.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#db
*/
db(dbName: string, options: DbOptions): Db;
/**
* Drop a collection from the database, removing it permanently. New accesses will create a new collection.
*
* @param name Name of collection to drop.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#dropCollection
*/
dropCollection(name: string): Promise<boolean>;
/**
* Drop a collection from the database, removing it permanently. New accesses will create a new collection.
*
* @param name Name of collection to drop.
* @param callback The results callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#dropCollection
*/
dropCollection(name: string, callback: MongoCallback<boolean>): void;
/**
* Drop a database, removing it permanently from the server.
*
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#dropDatabase
*/
dropDatabase(): Promise<any>;
/**
* Drop a database, removing it permanently from the server.
*
* @param callback The results callback.
* @see http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#dropDatabase
*/
dropDatabase(callback: MongoCallback<any>): void;
// deprecated http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#ensureIndex
// ensureIndex(collectionName: any, fieldOrSpec: any, options: IndexOptions, callback: Function): void;
// deprecated http://mongodb.github.io/node-mongodb-native/2.1/api/Db.html#eval