Home Reference Source

src/user.js

/** * Imports ***/
import Request from './request';
import { ItemResource } from './resource';

/**
 * User item resource object representing a user of the system.
 */
export default class User extends ItemResource {
  /**
   * Constructor
   *
   * @param {string} url - url of the resource
   * @param {Object} auth - authentication object
   * @param {string} auth.token - authentication token
   */
  constructor(url, auth) {
    super(url, auth);
  }

  /**
   * Make a PUT request to modify this user item resource through the REST API.
   *
   * @param {Object} data - request JSON data object
   * @param {string} data.password - user password
   * @param {string} data.email - user email
   * @param {number} [timeout=30000] - request timeout
   *
   * @return {Object} - JS Promise, resolves to ``this`` object
   */
  put(data, timeout = 30000) {
    return this._put(data, null, timeout);
  }
}