feat: make falso instantiable

Author: kobenguyent

README.md

@@ -61,12 +61,25 @@ yarn add @ngneat/falso
 
 ### Usage
 
+#### Static Usage (default)
+
 ```ts
-import { randEmail, randFullName } from '@ngneat/falso';
+import falso, { randEmail, randFullName } from '@ngneat/falso';
 
 const user = { email: randEmail(), name: randFullName() };
-
 const emails = randEmail({ length: 10 });
+
+// Or using the default instance
+const email = falso.randEmail();
+```
+
+#### Instantiable Usage
+
+```ts
+import { Falso } from '@ngneat/falso';
+
+const myFalso = new Falso();
+const email = myFalso.randEmail();
 ```
 
 You can specify the length of elements you want to generate. Below is an example of generating 10 emails with length equal or smaller than 20 characters.

package-lock.json

@@ -0,0 +1,19 @@
+import * as generators from './index';
+
+class Falso {
+  [key: string]: any;
+
+  constructor() {
+    // Optionally, allow for custom seeding or config here
+  }
+}
+
+// Attach all generator functions to the Falso prototype
+Object.entries(generators).forEach(([key, fn]) => {
+  if (typeof fn === 'function') {
+    Falso.prototype[key] = fn;
+  }
+});
+
+export { Falso };
+export const falso = new Falso();

packages/falso/src/falso-class.ts

@@ -1,3 +1,4 @@
+export { Falso, falso } from './falso-class';
 export { randAbbreviation } from './lib/abbreviation';
 export { randAccessory } from './lib/accessory';
 export { randAccount } from './lib/account';

packages/falso/src/index.ts

@@ -4,6 +4,7 @@ import * as randCountyFunctions from '../lib/county';
 import * as randCountryFunctions from '../lib/country';
 import * as randZipCodeFunctions from '../lib/zip-code';
 import { randAddress } from '../lib/address';
+import { Falso } from '../falso-class';
 
 describe('randAddress', () => {
   let randStreetAddressSpy: jest.SpyInstance;
@@ -49,6 +50,25 @@ describe('randAddress', () => {
     });
   });
 
+  it('should create address entity using Falso instance', () => {
+    randStreetAddressSpy.mockReturnValue('221B Baker Street');
+    randCitySpy.mockReturnValue('London');
+    randCountySpy.mockReturnValue('Greater London');
+    randCountrySpy.mockReturnValue('United Kingdom');
+    randZipCodeSpy.mockReturnValue('NW1 6XE');
+
+    const falso = new Falso();
+    const result = falso.randAddress();
+
+    expect(result).toEqual({
+      street: '221B Baker Street',
+      city: 'London',
+      county: 'Greater London',
+      country: 'United Kingdom',
+      zipCode: 'NW1 6XE',
+    });
+  });
+
   describe('includeCounty IS passed', () => {
     let includeCounty: boolean;
 

packages/falso/src/tests/address.spec.ts

@@ -1,4 +1,5 @@
 import { randAmount } from '../lib/amount';
+import { Falso } from '../falso-class';
 
 describe('amount', () => {
   it('should return a random amount between min and max default values', () => {
@@ -8,6 +9,14 @@ describe('amount', () => {
     expect(res).toBeLessThanOrEqual(max);
   });
 
+  it('should return a random amount using Falso instance', () => {
+    const [min, max] = [1.0, 9999.99];
+    const falso = new Falso();
+    const res = falso.randAmount();
+    expect(res).toBeGreaterThanOrEqual(min);
+    expect(res).toBeLessThanOrEqual(max);
+  });
+
   it('should return a list of random amount between min and max default values', () => {
     const [min, max] = [1.0, 9999.99];
     const res = randAmount({ min, max, length: 10 });