Rename toHierarchicalData to constructConfigurationObject

Author: Eskibear

src/AzureAppConfiguration.ts

@@ -16,17 +16,17 @@ export type AzureAppConfiguration = {
      * @param thisArg - Optional. Value to use as `this` when executing callback.
      */
     onRefresh(listener: () => any, thisArg?: any): Disposable;
-} & IGettable & IHierarchicalData;
+} & IGettable & IConfigurationObject;
 
-interface IHierarchicalData {
+interface IConfigurationObject {
     /**
-     * Convert the Map-styled data structure to hierarchical object properties.
+     * Construct configuration object based on Map-styled data structure and hierarchical keys.
      * @param options - The options to control the conversion behavior.
      */
-    toHierarchicalData(options?: HierarchicalDataConversionOptions): Record<string, any>;
+    constructConfigurationObject(options?: ConfigurationObjectConstructionOptions): Record<string, any>;
 }
 
-export interface HierarchicalDataConversionOptions {
+export interface ConfigurationObjectConstructionOptions {
     /**
      * The separator to use when converting hierarchical keys to object properties.
      * Default is '.'.

src/AzureAppConfigurationImpl.ts

@@ -3,7 +3,7 @@
 
 import { AppConfigurationClient, ConfigurationSetting, ConfigurationSettingId, GetConfigurationSettingOptions, GetConfigurationSettingResponse, ListConfigurationSettingsOptions } from "@azure/app-configuration";
 import { RestError } from "@azure/core-rest-pipeline";
-import { AzureAppConfiguration, HierarchicalDataConversionOptions } from "./AzureAppConfiguration";
+import { AzureAppConfiguration, ConfigurationObjectConstructionOptions } from "./AzureAppConfiguration";
 import { AzureAppConfigurationOptions } from "./AzureAppConfigurationOptions";
 import { IKeyValueAdapter } from "./IKeyValueAdapter";
 import { JsonKeyValueAdapter } from "./JsonKeyValueAdapter";
@@ -182,7 +182,7 @@ export class AzureAppConfigurationImpl implements AzureAppConfiguration {
     /**
      * Construct hierarchical data object from map.
      */
-    toHierarchicalData(options?: HierarchicalDataConversionOptions): Record<string, any> {
+    constructConfigurationObject(options?: ConfigurationObjectConstructionOptions): Record<string, any> {
         const separator = options?.separator ?? ".";
         const prefix = options?.prefix ?? "";
         const onError = options?.onError ?? "error";

test/load.test.ts

@@ -185,7 +185,7 @@ describe("load", function () {
             }]
         });
         expect(settings).not.undefined;
-        const data = settings.toHierarchicalData();
+        const data = settings.constructConfigurationObject();
         expect(data).not.undefined;
         expect(data.app.settings.fontColor).eq("red");
         expect(data.app.settings.fontSize).eq("40");
@@ -199,7 +199,7 @@ describe("load", function () {
             }]
         });
         expect(settings).not.undefined;
-        const data = settings.toHierarchicalData();
+        const data = settings.constructConfigurationObject();
         expect(data).not.undefined;
         expect(data.app2.settings.fontColor).eq("blue");
         expect(data.app2.settings.fontSize).eq(20);
@@ -238,7 +238,7 @@ describe("load", function () {
         expect(settings.get("app3.settings")).eq("placeholder");
         expect(settings.get("app3.settings.fontColor")).eq("yellow");
         // use data property
-        const data = settings.toHierarchicalData({ onError: "ignore" }); // ignore error on hierarchical key conversion
+        const data = settings.constructConfigurationObject({ onError: "ignore" }); // ignore error on hierarchical key conversion
         expect(data.app3.settings).not.eq("placeholder"); // not as expected.
         expect(data.app3.settings.fontColor).eq("yellow");
     });
@@ -252,7 +252,7 @@ describe("load", function () {
         });
         expect(settings).not.undefined;
         expect(() => {
-            settings.toHierarchicalData();
+            settings.constructConfigurationObject();
         }).to.throw("The key 'app3.settings' is not a valid path.");
     });
 });