Merge pull request #1466 from Tony133/chore/marked-apis-public

chore(): marked apis public
nestjs · Sep 18, 2023 · dadf916 · dadf916
2 parents e54ba02 + 12053da
commit dadf916
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 0 deletions.
diff --git a/lib/config-host.module.ts b/lib/config-host.module.ts
@@ -5,6 +5,10 @@ import {
 } from './config.constants';
 import { ConfigService } from './config.service';
 
+
+/**
+ * @publicApi
+ */
 @Global()
 @Module({
   providers: [

diff --git a/lib/config.module.ts b/lib/config.module.ts
@@ -20,6 +20,9 @@ import { createConfigProvider } from './utils/create-config-factory.util';
 import { getRegistrationToken } from './utils/get-registration-token.util';
 import { mergeConfigObject } from './utils/merge-configs.util';
 
+/**
+ * @publicApi
+ */
 @Module({
   imports: [ConfigHostModule],
   providers: [

diff --git a/lib/config.service.ts b/lib/config.service.ts
@@ -20,6 +20,10 @@ type ValidatedResult<
   T,
 > = WasValidated extends true ? T : T | undefined;
 
+
+/**
+ * @publicApi
+ */
 export interface ConfigGetOptions {
   /**
    * If present, "get" method will try to automatically
@@ -31,6 +35,10 @@ export interface ConfigGetOptions {
 
 type KeyOf<T> = keyof T extends never ? string : keyof T;
 
+
+/**
+ * @publicApi
+ */
 @Injectable()
 export class ConfigService<
   K = Record<string, unknown>,

diff --git a/lib/interfaces/config-module-options.interface.ts b/lib/interfaces/config-module-options.interface.ts
@@ -1,6 +1,9 @@
 import { ConfigFactory } from './config-factory.interface';
 import { DotenvExpandOptions } from 'dotenv-expand'
 
+/**
+ * @publicApi
+ */
 export interface ConfigModuleOptions {
   /**
    * If "true", values from the process.env object will be cached in the memory.

diff --git a/lib/types/config-object.type.ts b/lib/types/config-object.type.ts
@@ -1 +1,4 @@
+/**
+ * @publicApi
+ */
 export type ConfigObject = Record<string, any>;
diff --git a/lib/types/config.type.ts b/lib/types/config.type.ts
@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export type ConfigType<T extends (...args: any) => any> = T extends (
   ...args: any
 ) => infer ReturnVal

diff --git a/lib/utils/create-config-factory.util.ts b/lib/utils/create-config-factory.util.ts
@@ -4,6 +4,9 @@ import { ConfigFactory } from '../interfaces';
 import { getConfigToken } from './get-config-token.util';
 import { ConfigFactoryKeyHost } from './register-as.util';
 
+/**
+ * @publicApi
+ */
 export function createConfigProvider(
   factory: ConfigFactory & ConfigFactoryKeyHost,
 ): FactoryProvider {

diff --git a/lib/utils/get-config-token.util.ts b/lib/utils/get-config-token.util.ts
@@ -1,3 +1,6 @@
+/**
+ * @publicApi
+ */
 export function getConfigToken(token: string) {
   return `CONFIGURATION(${token})`;
 }
diff --git a/lib/utils/get-registration-token.util.ts b/lib/utils/get-registration-token.util.ts
@@ -1,5 +1,8 @@
 import { PARTIAL_CONFIGURATION_KEY } from '../config.constants';
 
+/**
+ * @publicApi
+ */
 export function getRegistrationToken(config: Record<string, any>) {
   return config[PARTIAL_CONFIGURATION_KEY];
 }
diff --git a/lib/utils/merge-configs.util.ts b/lib/utils/merge-configs.util.ts
@@ -1,5 +1,8 @@
 import set from 'lodash/set';
 
+/**
+ * @publicApi
+ */
 export function mergeConfigObject(
   host: Record<string, any>,
   partial: Record<string, any>,

diff --git a/lib/utils/register-as.util.ts b/lib/utils/register-as.util.ts
@@ -8,6 +8,9 @@ import { ConfigFactory } from '../interfaces';
 import { ConfigObject } from '../types';
 import { getConfigToken } from './get-config-token.util';
 
+/**
+ * @publicApi
+ */
 export interface ConfigFactoryKeyHost<T = unknown> {
   KEY: string;
   asProvider(): {
@@ -18,6 +21,8 @@ export interface ConfigFactoryKeyHost<T = unknown> {
 }
 
 /**
+ * @publicApi
+ * 
  * Registers the configuration object behind a specified token.
  */
 export function registerAs<