Need private packages and team management tools?Check out npm Orgs. »

mongoose-auto-api.consumer

1.0.0 • Public • Published

Mongoose Auto API - API Consumption Module

Build Status npm version

Automatic Mongoose REST API - Rest API Module ☕

Install

  • npm i -S mongoose-auto-api.consumer

Model Setup

Usage

$ consumer = require('mongoose-auto-api.consumer')

Methods

  • URL Attribute i.e. consumer.url
    • Gets API url
  • Port Attribute i.e. consumer.port
    • Gets API port
  • setPort
    • sets server port for requests
    • parm - port (Number)
  • setAuthToken
    • sets auth token for requests
    • parm - authToken (str)
  • Collection methods
    • parms - collection (str), args (obj)
    • insert -> /collection/insert
    • update -> /collection/update
    • remove -> /collection/delete
    • removeAll -> /collection/delete_all
    • get -> /collection/get
    • getAll -> /collection/get_all
    • find -> /collection/find
    • schemaInfo -> /collection/schema
    • sterilize -> /collection/sterilize
    • updatePush -> /collection/push
    • updatePushUnique -> /collection/push_unique
    • updateSet -> /collection/set
  • Auth methods
    • parms - args (obj)
      • args are url query parameters, see Rest API link above for query parameters
    • setSecretKey -> /update_secret_key
    • login -> /login
    • signup -> /signup
    • updatePassword -> /update_password
    • verifyToken -> /verify_token

Install

npm i mongoose-auto-api.consumer

DownloadsWeekly Downloads

3

Version

1.0.0

License

MIT

Unpacked Size

18.5 kB

Total Files

5

Last publish

Collaborators

  • avatar