Nuns Practicing Misanthropy

    referral-mongo

    2.3.9 • Public • Published

    Referral-mongo

    version: Beta

    Features

    • The change the referral chain
    • Referral system using mongoDB a distributed General purpose database based on documents

    Installation

    installing the module

    npm i referral-mongo

    installing the database

    sudo apt install -y mongodb
     
    sudo systemctl start mongodb

    Сonnection

    const {
      createReferal,
      getReferrals,
      updateReferal,
      deleteReferral 
    = require('referral-mongo')

    API create referral without parent

    returns a Promise:

    createReferal({
      userId: 1,
      data:{example:"your data"}
    })

    API create referral with parent

    returns a Promise:

    createReferal({
      userId: 2,
      parentId:1,
      data:{example:"your data"}
    })

    API update referral

    returns a Promise:

    createReferal({
      userId: 2,
      data:{example:"your data"}
    })

    API delete referral

    returns a Promise:

    deleteReferal({
      userId: 2,
      data:{example:"your data"}
    })

    Edit the .env file

    REFERRAL_LEVELS=3  // Set the depth of the referral system. By default three.
    
    REFERRAL_MONGODB_URL='mongodb://localhost:27017/referrals'  // Database address.
    
    REFERRAL_MONGODB_VERSION=3.6.3  // Version of your database.
    

    Install

    npm i referral-mongo

    DownloadsWeekly Downloads

    6

    Version

    2.3.9

    License

    ISC

    Unpacked Size

    6.57 kB

    Total Files

    12

    Last publish

    Collaborators

    • js-aliens