@nestia/fetcher 1.3.1 → 1.3.2

package/lib/IConnection.d.ts

@@ -20,26 +20,35 @@ export interface IConnection {
      */
     host: string;
     /**
-     * Use `typia.random<T>()` function instead.
+     * Header values delivered to the remote HTTP server.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Encryption password of its closure function.
+     */
+    encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+    /**
+     * Use simulation mode.
      *
-     * If you configure this property to be `true` or an {@link IRandomGenerator}
+     * If you configure this property to be `true` or assign an {@link IRandomGenerator}
      * instance, your SDK library does not send any request to remote backend server,
-     * but just returns a random data generated by `typia.random<T>()` function.
+     * but just returns random data generated by `typia.random<T>()` function with
+     * request data validation.
      *
-     * By the way, to utilize this random property, SDK library must be generated with
-     * {@link INestiaConfig.random} option, too. Open `nestia.config.ts` file, and
-     * configure {@link INestiaConfig.random} property to be true. Then newly generated
-     * SDK library would have a built-in random generator.
+     * By the way, to utilize this simulation mode, SDK library must be generated with
+     * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
+     * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
+     * generated SDK library would have a built-in mock-up data generator.
      *
      * @default false
      */
-    random?: boolean | Partial<IRandomGenerator>;
-    /**
-     * Header values delivered to the remote HTTP server.
-     */
-    headers?: Record<string, string>;
+    simulate?: boolean | Partial<IRandomGenerator>;
     /**
-     * Encryption password of its closure function.
+     * Use simulation mode.
+     *
+     * @default false
+     * @deprecated Use {@link simulate} property instead.
+     *             This property would be erased after v2.0 update
      */
-    encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+    random?: boolean | Partial<IRandomGenerator>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/fetcher",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Fetcher library of Nestia SDK",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/src/IConnection.ts

@@ -22,28 +22,38 @@ export interface IConnection {
     host: string;
 
     /**
-     * Use `typia.random<T>()` function instead.
+     * Header values delivered to the remote HTTP server.
+     */
+    headers?: Record<string, string>;
+
+    /**
+     * Encryption password of its closure function.
+     */
+    encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+
+    /**
+     * Use simulation mode.
      *
-     * If you configure this property to be `true` or an {@link IRandomGenerator}
+     * If you configure this property to be `true` or assign an {@link IRandomGenerator}
      * instance, your SDK library does not send any request to remote backend server,
-     * but just returns a random data generated by `typia.random<T>()` function.
+     * but just returns random data generated by `typia.random<T>()` function with
+     * request data validation.
      *
-     * By the way, to utilize this random property, SDK library must be generated with
-     * {@link INestiaConfig.random} option, too. Open `nestia.config.ts` file, and
-     * configure {@link INestiaConfig.random} property to be true. Then newly generated
-     * SDK library would have a built-in random generator.
+     * By the way, to utilize this simulation mode, SDK library must be generated with
+     * {@link INestiaConfig.simulate} option, too. Open `nestia.config.ts` file, and
+     * configure {@link INestiaConfig.simulate} property to be `true`. Them, newly
+     * generated SDK library would have a built-in mock-up data generator.
      *
      * @default false
      */
-    random?: boolean | Partial<IRandomGenerator>;
+    simulate?: boolean | Partial<IRandomGenerator>;
 
     /**
-     * Header values delivered to the remote HTTP server.
-     */
-    headers?: Record<string, string>;
-
-    /**
-     * Encryption password of its closure function.
+     * Use simulation mode.
+     *
+     * @default false
+     * @deprecated Use {@link simulate} property instead.
+     *             This property would be erased after v2.0 update
      */
-    encryption?: IEncryptionPassword | IEncryptionPassword.Closure;
+    random?: boolean | Partial<IRandomGenerator>;
 }