@harishreddym/baqend/lib/binding/Role.js

Baqend JavaScript SDK

'use strict';

const Entity = require('./Entity');
const User = require('./User');

/**
 * @alias binding.Role
 * @extends binding.Entity
 */
class Role extends Entity {
  /**
   * The default constructor, copy all given properties to this object
   * @param {Object=} properties - The optional properties to copy
   * @constructor
   */
}

Object.defineProperties(Role.prototype, /** @lends binding.Role.prototype */ {
  /**
   * Test if the given user has this role
   * @param {model.User} user The user to check
   * @return {boolean} <code>true</code> if the given user has this role,
   * otherwise <code>false</code>
   * @method
   */
  hasUser: {
    value: function hasUser(user) {
      return this.users && this.users.has(user);
    },
  },

  /**
   * Add the given user to this role
   * @param {model.User} user The user to add
   * @return {void}
   * @method
   */
  addUser: {
    value: function addUser(user) {
      if (user instanceof User) {
        if (!this.users) {
          this.users = new Set();
        }

        this.users.add(user);
      } else {
        throw new Error('Only user instances can be added to a role.');
      }
    },
  },

  /**
   * Remove the given user from this role
   * @param {model.User} user The user to remove
   * @return {void}
   * @method
   */
  removeUser: {
    value: function removeUser(user) {
      if (user instanceof User) {
        if (this.users) {
          this.users.delete(user);
        }
      } else {
        throw new Error('Only user instances can be removed from a role.');
      }
    },
  },
});

/**
 * A set of users which have this role
 * @type Set<model.User>
 * @name users
 * @memberOf binding.Role.prototype
 */

/**
 * The name of the role
 * @type string
 * @name name
 * @memberOf binding.Role.prototype
 */

module.exports = Role;