JSDoc: Global

Members

(constant) APIHelper

api-helper module

Source:

bin/helpers/api/cloudinary-helper.js, line 6

(constant) APIHelper

api-helper module

Source:

bin/helpers/api/geocoder-helper.js, line 7

(constant) APIHelper

api-helper class module

Source:

lib/controllers/campground-controller.js, line 29

(constant) async

async module.

Source:

lib/controllers/user-controller.js, line 17

(constant) Campground

Campground resource class module

Source:

bin/scripts/seeds/seed-all.js, line 21

(constant) Campground

Campground resource class module

Source:

lib/controllers/campground-controller.js, line 57

(constant) Campground

Campground resource class module

Source:

lib/controllers/comment-controller.js, line 36

(constant) Campground

Campground resource class module

Source:

lib/controllers/notification-controller.js, line 31

(constant) Campground

Campground resource class module

Source:

lib/controllers/user-controller.js, line 51

(constant) Campground

Campground resource class module

Source:

lib/middleware/index.js, line 19

(constant) CampgroundController

campground-controller module.

Source:

bin/scripts/seeds/seed-all.js, line 37

(constant) CloudinaryHelper

cloudinary-helper class module

Source:

lib/controllers/campground-controller.js, line 39

(constant) Comment

Comment resource class module

Source:

bin/scripts/seeds/seed-all.js, line 26

(constant) Comment

Comment resource class module

Source:

lib/controllers/campground-controller.js, line 62

(constant) Comment

Comment resource class module

Source:

lib/controllers/comment-controller.js, line 41

(constant) Comment

Comment resource class module

Source:

lib/controllers/notification-controller.js, line 36

(constant) Comment

Comment resource class module

Source:

lib/controllers/user-controller.js, line 56

(constant) Comment

Comment resource class module

Source:

lib/middleware/index.js, line 24

(constant) Comment

Comment resource class module

Source:

lib/models/campground.js, line 11

(constant) CONFIG

Default Value:

{"cloud_name":"","api_key":"","api_secret":""}

Source:

bin/helpers/api/cloudinary-helper.js, line 22

(constant) CONFIG

Default Value:

{"provider":"google","httpAdapter":"https","apiKey":"","formatter":null}

Source:

bin/helpers/api/geocoder-helper.js, line 23

(constant) crypto

crypto module.

Source:

lib/controllers/user-controller.js, line 27

(constant) DB_PROVIDER

Default Value:

MongoDB

Source:

lib/controllers/campground-controller.js, line 73

(constant) DB_PROVIDER

Default Value:

MongoDB

Source:

lib/controllers/comment-controller.js, line 47

(constant) DB_PROVIDER

Default Value:

MongoDB

Source:

lib/controllers/notification-controller.js, line 47

(constant) DB_PROVIDER

Source:

lib/controllers/user-controller.js, line 67

(constant) DB_PROVIDER

Default Value:

MongoDB

Source:

lib/middleware/index.js, line 30

(constant) errors

errors module

Source:

bin/helpers/api/cloudinary-helper.js, line 16

(constant) errors

errors module

Source:

bin/helpers/api/geocoder-helper.js, line 12

(constant) errors

errors module

Source:

lib/controllers/campground-controller.js, line 24

(constant) errors

errors module

Source:

lib/controllers/comment-controller.js, line 23

(constant) errors

errors module

Source:

lib/controllers/notification-controller.js, line 18

(constant) errors

errors module

Source:

lib/controllers/user-controller.js, line 38

(constant) errors

errors module

Source:

lib/middleware/index.js, line 6

(constant) errors

errors module

Source:

lib/middleware/mongoose/global-pre-hooks.js, line 11

(constant) errors

errors module

Source:

lib/middleware/mongoose/mongoose-middleware.js, line 11

(constant) errors

errors class module

Source:

lib/models/campground.js, line 25

(constant) errors

errors class module

Source:

lib/models/comment.js, line 10

(constant) express

express module

Source:

lib/controllers/campground-controller.js, line 8

(constant) express

express module

Source:

lib/controllers/comment-controller.js, line 7

(constant) express

express module

Source:

lib/controllers/notification-controller.js, line 7

(constant) express

express module

Source:

lib/controllers/user-controller.js, line 7

(constant) GeneralHelper

general-helper class module

Source:

lib/controllers/campground-controller.js, line 44

(constant) GeocoderHelper

geocoder-helper class module

Source:

lib/controllers/campground-controller.js, line 34

(constant) middleware

middleware module. If file is not specified than it will require index.js in specified folder

Source:

lib/controllers/campground-controller.js, line 14

(constant) middleware

middleware module. If file is not specified than it will require index.js in specified folder

Source:

lib/controllers/comment-controller.js, line 18

(constant) middleware

middleware module. If file is not specified than it will require index.js in specified folder

Source:

lib/controllers/notification-controller.js, line 13

(constant) middleware

middleware module. If file is not specified than it will require index.js in specified folder

Source:

lib/controllers/user-controller.js, line 33

(constant) mongoose

mongoose module

Source:

bin/scripts/seeds/seed-all.js, line 6

(constant) mongoose

mongoose module

Source:

bin/scripts/seeds/seeds.js, line 9

(constant) mongoose

mongoose module

Source:

lib/controllers/comment-controller.js, line 12

(constant) mongoose

mongoose module

Source:

lib/middleware/mongoose/global-pre-hooks.js, line 6

(constant) mongoose

mongoose module

Source:

lib/middleware/mongoose/mongoose-middleware.js, line 6

(constant) mongoose

mongoose module

Source:

lib/models/campground.js, line 6

(constant) mongoose

mongoose module

Source:

lib/models/comment.js, line 6

(constant) multer

multer module

Source:

bin/helpers/api/cloudinary-helper.js, line 11

(constant) multer

multer module

Source:

lib/controllers/campground-controller.js, line 19

(constant) NodeGeocoder

node-geocoder module

Source:

bin/helpers/api/geocoder-helper.js, line 17

(constant) nodemailer

nodemailer module.

Source:

lib/controllers/user-controller.js, line 22

(constant) Notification

Notification resource class module

Source:

bin/scripts/seeds/seed-all.js, line 31

(constant) Notification

Notification resource class module

Source:

lib/controllers/campground-controller.js, line 67

(constant) Notification

Notification resource class module

Source:

lib/controllers/notification-controller.js, line 41

(constant) Notification

Notification resource class module

Source:

lib/controllers/user-controller.js, line 61

(constant) Notification

Notification class module

Source:

lib/models/campground.js, line 16

(constant) passport

passport module.

Source:

bin/scripts/seeds/seed-all.js, line 11

(constant) passport

passport module.

Source:

lib/controllers/user-controller.js, line 12

(constant) PROVIDER

Default Value:

MongoDB

Source:

lib/middleware/mongoose/global-pre-hooks.js, line 17

(constant) PROVIDER

Default Value:

MongoDB

Source:

lib/middleware/mongoose/mongoose-middleware.js, line 17

(constant) seedAll

seed-all module

Source:

bin/scripts/seeds/seeds.js, line 14

(constant) Slug

Slug class module

Source:

lib/models/campground.js, line 21

(constant) staticProperties

Default Value:

{"COLLECTION_NAME":"Comment","PRIMARY_KEY":"_id"}

Source:

lib/models/comment.js, line 16

(constant) staticProperties

Default Value:

```
{"COLLECTION_NAME":"Notification"}
```

Source:

lib/models/notification.js, line 7

(constant) staticProperties

Default Value:

```
{"COLLECTION_NAME":"User"}
```

Source:

lib/models/user.js, line 11

(constant) User

User resource class module

Source:

bin/scripts/seeds/seed-all.js, line 16

Methods

module:lib/middleware/mongoose/global-pre-hooks(schema, options)

Represents the global pre hooks for Mongoose middleware to protect read-only version of the web-site.

Parameters:

Name	Type	Description
`schema`	Schema	The schema of the resource for which a modification is being attempted.
`options`	Object	The options used for modifying the execution of the middleware.

Author:

Jose Nicolas Mora

Source:

lib/middleware/mongoose/global-pre-hooks.js, line 31

module:lib/middleware/mongoose/mongoose-middleware(schema, options)

Represents the plugin function middleware used for handling read-only website errors.

Parameters:

Name	Type	Description
`schema`	Schema	The schema of the resource for which a modification is being attempted.
`options`	Object	The options used for modifying the execution of the middleware.

Author:

Jose Nicolas Mora

Source:

lib/middleware/mongoose/mongoose-middleware.js, line 33