add TSdoc for public API and types (#32)

Author: Eskibear

src/AzureAppConfigurationOptions.ts

@@ -28,7 +28,21 @@ export interface AzureAppConfigurationOptions {
      * Backslash `\` character is reserved and must be escaped using another backslash `\`.
      */
     selectors?: { keyFilter: string, labelFilter?: string }[];
+
+    /**
+     * Specifies prefixes to be trimmed from the keys of all key-values retrieved from Azure App Configuration.
+     * This is useful when you want to remove a common prefix from all keys to avoid repetition.
+     * The provided prefixes will be sorted in descending order and the longest matching prefix will be trimmed first.
+     */
     trimKeyPrefixes?: string[];
+
+    /**
+     * Specifies custom options to be used when creating the AppConfigurationClient.
+     */
     clientOptions?: AppConfigurationClientOptions;
+
+    /**
+     * Specifies options used to resolve Vey Vault references.
+     */
     keyVaultOptions?: AzureAppConfigurationKeyVaultOptions;
 }

src/keyvault/AzureAppConfigurationKeyVaultOptions.ts

@@ -4,8 +4,24 @@
 import { TokenCredential } from "@azure/identity";
 import { SecretClient } from "@azure/keyvault-secrets";
 
+/**
+ * Options used to resolve Key Vault references.
+ */
 export interface AzureAppConfigurationKeyVaultOptions {
+    /**
+     * Specifies the Key Vault secret client used for resolving Key Vault references.
+     */
     secretClients?: SecretClient[];
+
+    /**
+     * Specifies the credentials used to authenticate to key vaults that have no applied SecretClient.
+     */
     credential?: TokenCredential;
+
+    /**
+     * Specifies the callback used to resolve key vault references that have no applied SecretClient.
+     * @param keyVaultReference The Key Vault reference to resolve.
+     * @returns The secret value.
+     */
     secretResolver?: (keyVaultReference: URL) => string | Promise<string>;
 }

src/load.ts

@@ -8,7 +8,18 @@ import { AzureAppConfigurationImpl } from "./AzureAppConfigurationImpl";
 import { AzureAppConfigurationOptions, MaxRetries, MaxRetryDelayInMs } from "./AzureAppConfigurationOptions";
 import * as RequestTracing from "./requestTracing/constants";
 
+/**
+ * Loads the data from Azure App Configuration service and returns an instance of AzureAppConfiguration.
+ * @param connectionString  The connection string for the App Configuration store.
+ * @param options  Optional parameters.
+ */
 export async function load(connectionString: string, options?: AzureAppConfigurationOptions): Promise<AzureAppConfiguration>;
+/**
+ * Loads the data from Azure App Configuration service and returns an instance of AzureAppConfiguration.
+ * @param endpoint  The URL to the App Configuration store.
+ * @param credential  The credential to use to connect to the App Configuration store.
+ * @param options  Optional parameters.
+ */
 export async function load(endpoint: URL | string, credential: TokenCredential, options?: AzureAppConfigurationOptions): Promise<AzureAppConfiguration>;
 export async function load(
     connectionStringOrEndpoint: string | URL,