fs/lib/AbstractReaderWriter.js

  1. const AbstractReader = require("./AbstractReader");
  3. /**
  4.  * Abstract resource locator
  5.  *
  6.  * @public
  7.  * @abstract
  8.  * @memberof module:@ui5/fs
  9.  * @augments module:@ui5/fs.AbstractReader
  10.  */
  11. class AbstractReaderWriter extends AbstractReader {
  12. 	/**
  13. 	 * The constructor.
  14. 	 *
  15. 	 * @public
  16. 	 */
  17. 	constructor() {
  18. 		if (new.target === AbstractReaderWriter) {
  19. 			throw new TypeError("Class 'AbstractReaderWriter' is abstract");
  20. 		}
  21. 		super();
  22. 	}
  24. 	/**
  25. 	 * Writes the content of a resource to a path.
  26. 	 *
  27. 	 * @public
  28. 	 * @param {module:@ui5/fs.Resource} resource Resource to write
  29. 	 * @param {object} [options]
  30. 	 * @param {boolean} [options.readOnly=false] Whether the resource content shall be written read-only
  31. 	 *						Do not use in conjunction with the <code>drain</code> option.
  32. 	 *						The written file will be used as the new source of this resources content.
  33. 	 *						Therefore the written file should not be altered by any means.
  34. 	 *						Activating this option might improve overall memory consumption.
  35. 	 * @param {boolean} [options.drain=false] Whether the resource content shall be emptied during the write process.
  36. 	 *						Do not use in conjunction with the <code>readOnly</code> option.
  37. 	 *						Activating this option might improve overall memory consumption.
  38. 	 *						This should be used in cases where this is the last access to the resource.
  39. 	 *						E.g. the final write of a resource after all processing is finished.
  40. 	 * @returns {Promise<undefined>} Promise resolving once data has been written
  41. 	 */
  42. 	write(resource, options = {drain: false, readOnly: false}) {
  43. 		return this._write(resource, options);
  44. 	}
  46. 	/**
  47. 	 * Writes the content of a resource to a path.
  48. 	 *
  49. 	 * @abstract
  50. 	 * @protected
  51. 	 * @param {module:@ui5/fs.Resource} resource Resource to write
  52. 	 * @param {object} [options] Write options, see above
  53. 	 * @returns {Promise<undefined>} Promise resolving once data has been written
  54. 	 */
  55. 	_write(resource, options) {
  56. 		throw new Error("Not implemented");
  57. 	}
  58. }
  60. module.exports = AbstractReaderWriter;