Source: models/File.js

  1. var assign = require('object-assign');
  3. var Node = require('./Node');
  4. require('../polyfill');
  6. /**
  7.  * Create a file from the server's object representation.
  8.  *
  9.  * @param {Object} obj Data from the server, which doesn't follow typical
  10.  *                     javaScript naming conventions.
  11.  * @constructor
  12.  * @memberof models
  13.  */
  14. function File(obj) {
  15.   this._data = obj || {};
  17.   var self = this;
  19.   Object.defineProperties(this, {
  20.     /**
  21.      * The absolute depot path of the file
  22.      *
  23.      * @type string
  24.      * @name models.File#depotFile
  25.      * @memberOf models.File
  26.      */
  27.     'depotFile': {
  28.       get: function() {
  29.         return self._data['DepotFile'];
  30.       },
  31.       set: function(x) {
  32.         self._data['DepotFile'] = x;
  33.       }
  34.     },
  35.     /**
  36.      * File's revision number.
  37.      *
  38.      * @type number
  39.      * @name models.File#revision
  40.      * @memberOf models.File
  41.      * @readonly
  42.      */
  43.     'revision': {
  44.       get: function() {
  45.         var n = self._data['Revision'];
  46.         if (typeof n == 'string') {
  47.           n = parseInt(n);
  48.         }
  49.         return n;
  50.       }
  51.     },
  52.     /**
  53.      * ID of the changelist that created this file revision.
  54.      *
  55.      * @type string
  56.      * @name models.File#change
  57.      * @memberOf models.File
  58.      * @readonly
  59.      */
  60.     'change': {
  61.       get: function() {
  62.         return self._data['Change'];
  63.       }
  64.     },
  65.     /**
  66.      * Action taken at the head, one of 'add', 'edit', 'delete', 'branch',
  67.      * 'move_add', 'move_delete', 'integrate', 'import', 'purge', or 'archive'.
  68.      *
  69.      * @type string
  70.      * @name models.File#action
  71.      * @memberOf models.File
  72.      * @readonly
  73.      */
  74.     'action': {
  75.       get: function() {
  76.         return self._data['Action'];
  77.       }
  78.     },
  79.     /**
  80.      * File type - one of 'text', 'binary', 'symlink', 'apple', 'resource',
  81.      * 'unicode', 'utf16'
  82.      *
  83.      * @type string
  84.      * @name models.File#type
  85.      * @memberOf models.File
  86.      * @readonly
  87.      */
  88.     'type': {
  89.       get: function() {
  90.         return self._data['Type'];
  91.       }
  92.     },
  93.     /**
  94.      * Date of when the file revision was created
  95.      *
  96.      * @type Date
  97.      * @name models.File#date
  98.      * @memberOf models.File
  99.      * @readonly
  100.      */
  101.     'date': {
  102.       get: function() {
  103.         return new Date(self._data['Date']);
  104.       }
  105.     },
  106.     /**
  107.      * For consistency with Node operations
  108.      *
  109.      * @type string
  110.      * @name models.File#name
  111.      * @memberOf models.File
  112.      * @readonly
  113.      */
  114.     'name': {
  115.       get: function() {
  116.         return this.pathId[this.pathId.length - 1];
  117.       }
  118.     },
  119.     /**
  120.      * For consistency with Node operations
  121.      *
  122.      * @type Array<string>
  123.      * @name models.File#pathId
  124.      * @memberOf models.File
  125.      * @readonly
  126.      */
  127.     'pathId': {
  128.       get: function() {
  129.         var path = this.depotFile;
  130.         if (path.startsWith('//')) {
  131.           path = path.substring(2);
  132.         }
  133.         return path.split('/');
  134.       }
  135.     }
  136.   });
  137. }
  139. assign(File.prototype, Node, {
  141. });
  143. module.exports = File;