fs/lib/DuplexCollection.js

  1. const AbstractReaderWriter = require("./AbstractReaderWriter");
  2. const ReaderCollectionPrioritized = require("./ReaderCollectionPrioritized");
  4. /**
  5.  * Wrapper to keep readers and writers together
  6.  *
  7.  * @public
  8.  * @memberof module:@ui5/fs
  9.  * @augments module:@ui5/fs.AbstractReaderWriter
  10.  */
  11. class DuplexCollection extends AbstractReaderWriter {
  12. 	/**
  13. 	 * The Constructor.
  14. 	 *
  15. 	 * @param {object} parameters
  16. 	 * @param {module:@ui5/fs.AbstractReader} parameters.reader Single reader or collection of readers
  17. 	 * @param {module:@ui5/fs.AbstractReaderWriter} parameters.writer
  18. 	 *			A ReaderWriter instance which is only used for writing files
  19. 	 * @param {string} [parameters.name=""] The collection name
  20. 	 */
  21. 	constructor({reader, writer, name = ""}) {
  22. 		super();
  23. 		this._reader = reader;
  24. 		this._writer = writer;
  26. 		this._combo = new ReaderCollectionPrioritized({
  27. 			name: name,
  28. 			readers: [
  29. 				writer,
  30. 				reader
  31. 			]
  32. 		});
  33. 	}
  35. 	/**
  36. 	 * Locates resources by glob.
  37. 	 *
  38. 	 * @private
  39. 	 * @param {string|string[]} virPattern glob pattern as string or an array of
  40. 	 *         glob patterns for virtual directory structure
  41. 	 * @param {object} options glob options
  42. 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
  43. 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with a list of resources
  44. 	 */
  45. 	_byGlob(virPattern, options, trace) {
  46. 		return this._combo._byGlob(virPattern, options, trace);
  47. 	}
  49. 	/**
  50. 	 * Locates resources by glob from source reader only.
  51. 	 * For found resources that are also available in the writer, the writer resource will be returned.
  52. 	 *
  53. 	 * @param {string} virPattern glob pattern for virtual directory structure
  54. 	 * @param {object} [options] glob options
  55. 	 * @param {boolean} [options.nodir=true] Do not match directories
  56. 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
  57. 	 */
  58. 	byGlobSource(virPattern, options = {nodir: true}) {
  59. 		return this._reader.byGlob(virPattern, options).then((resources) => {
  60. 			return Promise.all(resources.map((readerResource) => {
  61. 				return this._writer.byPath(readerResource.getPath()).then((writerResource) => {
  62. 					return writerResource || readerResource;
  63. 				});
  64. 			}));
  65. 		});
  66. 	}
  68. 	/**
  69. 	 * Locates resources by path.
  70. 	 *
  71. 	 * @private
  72. 	 * @param {string} virPath Virtual path
  73. 	 * @param {object} options Options
  74. 	 * @param {module:@ui5/fs.tracing.Trace} trace Trace instance
  75. 	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
  76. 	 */
  77. 	_byPath(virPath, options, trace) {
  78. 		return this._combo._byPath(virPath, options, trace);
  79. 	}
  81. 	/**
  82. 	 * Writes the content of a resource to a path.
  83. 	 *
  84. 	 * @private
  85. 	 * @param {module:@ui5/fs.Resource} resource The Resource to write
  86. 	 * @returns {Promise<undefined>} Promise resolving once data has been written
  87. 	 */
  88. 	_write(resource) {
  89. 		return this._writer.write(resource);
  90. 	}
  91. }
  93. module.exports = DuplexCollection;