Skip to content

Commit d03c74e

Browse files
committed
README, Docs and method comments updated
1 parent dbc32cf commit d03c74e

40 files changed

+25668
-651
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Contentstack is a headless CMS with an API-first approach. It is a CMS that deve
1919
|dbName|string|contentstack-persistent-db|**Optional** The MongoDB database name|
2020
|collectionName|string|contents|**Optional** MongoDB database's collection name|
2121
|uri|string|mongodb://localhost:27017 |**Optional.** The MongoDB connection URI|
22+
|limit|number|100|**Optional.** Caps the total no of objects returned in a single call|
23+
|skip|number|0|**Optional.** Number of objects skipped before the result is returned|
2224
| indexes | object |**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Option to create db indexes via configuration|
2325
|projections|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** Mongodb projections. Keys provided here would be displayed/filtered out when fetching the result|
2426
|options|object|**[see config below](https://github.com/contentstack/datasync-content-store-mongodb#detailed-configs)** |**Optional.** MongoDB connection options [Ref.](http://mongodb.github.io/node-mongodb-native/3.1/api/MongoClient.html) for more info|
25-
|limit|number|**Optional.** Caps the total no of objects returned in a single call|
26-
|skip|number|**Optional.** Number of objects skipped before the result is returned|
2727

2828
### Detailed configs
2929

dist/index.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,16 @@ const stack_1 = require("./stack");
2323
* ]
2424
* })
2525
*
26-
* @returns {Stack}
26+
* @returns {Stack} Returns Stack method, which's used to create an instance of Stack
2727
*/
2828
class Contentstack {
2929
/**
30-
* @summary
31-
* Initialize Stack instance
32-
* @param {Object} stack_arguments - Stack config
30+
* @public
31+
* @method Stack
32+
* @summary Initialize Stack instance
33+
* @param {object} config Stack config
34+
* @param {object} db Existing db connection
35+
* @returns {Stack} - Returns an instance of `Stack`
3336
*/
3437
static Stack(config, db) {
3538
return new stack_1.Stack(config, db);

0 commit comments

Comments
 (0)