Merge remote-tracking branch 'origin/main' into feat/220-unique-values

ngneat · Mar 22, 2022 · 485782e · 485782e
2 parents 6160c3c + 21bcefb
commit 485782e
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 8 deletions.
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -12,6 +12,9 @@ module.exports = {
     favicon: 'img/favicon.ico',
     organizationName: 'ngneat',
     projectName: 'falso',
+    clientModules: [
+        require.resolve('./src/consolePlayground/index.js'),
+    ],
     themeConfig: {
         colorMode: {
             respectPrefersColorScheme: true,

diff --git a/docs/src/consolePlayground/index.js b/docs/src/consolePlayground/index.js
@@ -0,0 +1,12 @@
+import * as falso from '../theme/ReactLiveScope/falso.min';
+
+if (typeof window !== 'undefined') {
+	window.onload = function () {
+		const titleStyles = 'color:#8a76d9; font-size: 22px; font-weight:bold;';
+		const copyStyles = 'color:white; font-size: 14px';
+		const exampleStyles = 'color:#8a76d9; font-size: 14px;';
+		console.log('%cFalso\n\n' + '%cYou can use _ to access Falso functions here in the console. \n\n%c' + 'For example: _.randFullName()', titleStyles, copyStyles, exampleStyles)
+
+		window._ = falso;
+	};
+}
diff --git a/packages/falso/CHANGELOG.md b/packages/falso/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+# [3.1.0](https://github.com/ngneat/falso/compare/falso-3.0.0...falso-3.1.0) (2022-03-22)
+
+### Features
+
+- add precision to randNumber ([44fdcd6](https://github.com/ngneat/falso/commit/44fdcd61014705de6aa8368f2276ebd6fd80abd0)), closes [#226](https://github.com/ngneat/falso/issues/226)
+
 # [3.0.0](https://github.com/ngneat/falso/compare/falso-2.27.0...falso-3.0.0) (2022-03-08)
 
 ### Bug Fixes

diff --git a/packages/falso/package.json b/packages/falso/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ngneat/falso",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "license": "MIT",
   "description": "All the Fake Data for All Your Real Needs",
   "keywords": [

diff --git a/packages/falso/src/lib/credit-card.ts b/packages/falso/src/lib/credit-card.ts
@@ -28,7 +28,7 @@ export interface CreditCard {
 /**
  * Generate a random credit card.
  *
- * @category finance, entity
+ * @category finance, entities
  *
  * @example
  *

diff --git a/packages/falso/src/lib/float.ts b/packages/falso/src/lib/float.ts
@@ -20,10 +20,22 @@ export interface RandomFloatOptions extends RandomInRangeOptions, FakeOptions {}
  *
  * randFloat({ length: 10 })
  *
+ * @example
+ *
+ * randFloat({ min: 10, max: 20, fraction: 1 }) // 12.5
+ *
+ * @example
+ *
+ * randFloat({ min: 10, max: 20, fraction: 2 }) // 12.52
  */
 export function randFloat<Options extends RandomFloatOptions = never>(
   options?: Options
 ) {
-  const o = { ...options, fraction: options?.fraction ?? 2 };
+  const o: RandomFloatOptions = {
+    ...options,
+    fraction: options?.fraction ?? 2,
+  };
   return fake(() => getRandomInRange(o), options);
 }
+
+randFloat();
diff --git a/packages/falso/src/lib/number.ts b/packages/falso/src/lib/number.ts
@@ -5,9 +5,8 @@ import {
   RandomInRangeOptions,
 } from './core/core';
 
-export interface RandomNumberOptions extends FakeOptions {
-  min?: number;
-  max?: number;
+export interface RandomNumberOptions extends RandomInRangeOptions, FakeOptions {
+  precision?: number;
 }
 
 /**
@@ -27,14 +26,32 @@ export interface RandomNumberOptions extends FakeOptions {
  *
  * randNumber({ min: 10, max: 1000 }) // default is 'min': 0, 'max': 999_999
  *
+ * @example
+ *
+ * randNumber({ min: 1000, max: 100000, precision: 1000 }) // 67000
+ *
+ * @example
+ *
+ * randNumber({ min: 1000, max: 2000, precision: 100 }) // 1200
+ *
+ * @example
+ *
+ * randNumber({ min: 1000, max: 2000, precision: 10 }) // 1250
  */
 export function randNumber<Options extends RandomNumberOptions = never>(
   options?: Options
 ) {
-  const config: RandomInRangeOptions = {
+  const o: RandomNumberOptions = {
     min: options?.min || 0,
     max: options?.max || 999_999,
+    precision: options?.precision,
   };
 
-  return fake(() => getRandomInRange(config), options);
+  return fake(() => {
+    const num = getRandomInRange(o);
+    if (o.precision !== undefined) {
+      return Math.floor(num / o.precision) * o.precision;
+    }
+    return num;
+  }, options);
 }
diff --git a/packages/falso/src/tests/number.spec.ts b/packages/falso/src/tests/number.spec.ts
@@ -0,0 +1,17 @@
+import { randNumber } from '../lib/number';
+
+describe('randNumber', () => {
+  it('should return a random number', () => {
+    const [min, max] = [1, 999_999];
+    const num = randNumber({ min, max });
+    expect(typeof num).toBe('number');
+    expect(num).toBeGreaterThanOrEqual(min);
+    expect(num).toBeLessThanOrEqual(max);
+  });
+
+  it('should support precision', () => {
+    const num = randNumber({ min: 1000, max: 2000, precision: 100 });
+    expect(typeof num).toBe('number');
+    expect(String(num)).toMatch(/^\d\d00$/);
+  });
+});
diff --git a/packages/falso/src/tests/random-float.spec.ts b/packages/falso/src/tests/random-float.spec.ts
@@ -24,4 +24,10 @@ describe('random-float', () => {
     expect(randFloat({ max })).toBeLessThanOrEqual(max);
     expect(randFloat({ max })).toBeGreaterThanOrEqual(1.0);
   });
+
+  it('should support fraction', () => {
+    const num = randFloat({ min: 100, max: 200, fraction: 2 });
+    expect(typeof num).toBe('number');
+    expect(String(num)).toMatch(/^\d+\.\d\d$/);
+  });
 });