#1350: replace fs....Sync() methods with async versions to workaround t…

…schaub/mock-fs#377
Accenture · May 31, 2024 · c8f40d0 · c8f40d0
1 parent ec7dffa
commit c8f40d0
Show file tree

Hide file tree

Showing 29 changed files with 139 additions and 102 deletions.
diff --git a/@types/lib/Deployer.d.ts b/@types/lib/Deployer.d.ts
@@ -62,9 +62,9 @@ declare class Deployer {
      * @param {string} deployDir root directory of metadata.
      * @param {string[]} [typeArr] limit deployment to given metadata type
      * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
-     * @returns {MultiMetadataTypeMap} Metadata of BU in local directory
+     * @returns {Promise.<MultiMetadataTypeMap>} Metadata of BU in local directory
      */
-    static readBUMetadata(deployDir: string, typeArr?: string[], listBadKeys?: boolean): MultiMetadataTypeMap;
+    static readBUMetadata(deployDir: string, typeArr?: string[], listBadKeys?: boolean): Promise<MultiMetadataTypeMap>;
     /**
      * parses asset metadata to auto-create folders in target folder
      *

diff --git a/@types/lib/Deployer.d.ts.map b/@types/lib/Deployer.d.ts.map
diff --git a/@types/lib/metadataTypes/Asset.d.ts b/@types/lib/metadataTypes/Asset.d.ts
@@ -293,9 +293,9 @@ declare class Asset extends MetadataType {
      * @param {string} dir directory that contains '.json' files to be read
      * @param {boolean} _ unused parameter
      * @param {string[]} selectedSubType asset, message, ...
-     * @returns {MetadataTypeMap} fileName => fileContent map
+     * @returns {Promise.<MetadataTypeMap>} fileName => fileContent map
      */
-    static getJsonFromFS(dir: string, _: boolean, selectedSubType: string[]): MetadataTypeMap;
+    static getJsonFromFS(dir: string, _: boolean, selectedSubType: string[]): Promise<MetadataTypeMap>;
     /**
      * optional method used for some types to try a different folder structure
      *
@@ -359,9 +359,9 @@ declare class Asset extends MetadataType {
      *
      * @param {string} subType asset subtype
      * @param {object} item api response for metadata
-     * @returns {object} JS object of the asset we loaded from disk
+     * @returns {Promise.<object>} JS object of the asset we loaded from disk
      */
-    static "__#1@#getJson"(subType: string, item: object): object;
+    static "__#1@#getJson"(subType: string, item: object): Promise<object>;
 }
 declare namespace Asset {
     let definition: {

diff --git a/@types/lib/metadataTypes/Asset.d.ts.map b/@types/lib/metadataTypes/Asset.d.ts.map
diff --git a/@types/lib/metadataTypes/Folder.d.ts b/@types/lib/metadataTypes/Folder.d.ts
@@ -80,9 +80,9 @@ declare class Folder extends MetadataType {
      *
      * @param {string} dir directory that contains '.json' files to be read
      * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
-     * @returns {MetadataTypeMap} fileName => fileContent map
+     * @returns {Promise.<MetadataTypeMap>} fileName => fileContent map
      */
-    static getJsonFromFS(dir: string, listBadKeys?: boolean): MetadataTypeMap;
+    static getJsonFromFS(dir: string, listBadKeys?: boolean): Promise<MetadataTypeMap>;
     /**
      * Helper to retrieve the folders as promise
      *

diff --git a/@types/lib/metadataTypes/Folder.d.ts.map b/@types/lib/metadataTypes/Folder.d.ts.map
diff --git a/@types/lib/metadataTypes/MetadataType.d.ts b/@types/lib/metadataTypes/MetadataType.d.ts
@@ -26,9 +26,9 @@ declare class MetadataType {
      * @param {string} dir directory that contains '.json' files to be read
      * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
      * @param {string[]} [selectedSubType] asset, message, ...
-     * @returns {MetadataTypeMap} fileName => fileContent map
+     * @returns {Promise.<MetadataTypeMap>} fileName => fileContent map
      */
-    static getJsonFromFS(dir: string, listBadKeys?: boolean, selectedSubType?: string[]): MetadataTypeMap;
+    static getJsonFromFS(dir: string, listBadKeys?: boolean, selectedSubType?: string[]): Promise<MetadataTypeMap>;
     /**
      * Returns fieldnames of Metadata Type. 'this.definition.fields' variable only set in child classes.
      *
@@ -608,9 +608,9 @@ declare class MetadataType {
      * @param {string} readDir root directory of metadata.
      * @param {boolean} [listBadKeys] do not print errors, used for badKeys()
      * @param {object} [buMetadata] Metadata of BU in local directory
-     * @returns {object} Metadata of BU in local directory
+     * @returns {Promise.<object>} Metadata of BU in local directory
      */
-    static readBUMetadataForType(readDir: string, listBadKeys?: boolean, buMetadata?: object): object;
+    static readBUMetadataForType(readDir: string, listBadKeys?: boolean, buMetadata?: object): Promise<object>;
     /**
      * should return only the json for all but asset, query and script that are saved as multiple files
      * additionally, the documentation for dataExtension and automation should be returned