fs/lib/DuplexCollection.js

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