feat: 🔥 Add custom comparison functions non-conforming function

✅ Closes: #220

packages/falso/src/lib/address.ts

@@ -64,5 +64,12 @@ export function randAddress<Options extends AddressOptions = never>(
     return address;
   };
 
-  return fake(factory, options);
+  return fake(factory, options, comparisonFunction);
 }
+
+const comparisonFunction: (item: Address, items: Address[]) => boolean = (
+  item: Address,
+  items: Address[]
+) => {
+  return items.some((i) => i.street + i.zipCode === item.street + item.zipCode);
+};

packages/falso/src/lib/between-date.ts

@@ -1,4 +1,4 @@
-import { fake, FakeOptions } from './core/core';
+import { dateComparisonFunction, fake, FakeOptions } from './core/core';
 import { randNumber } from './number';
 
 interface BetweenOptions extends FakeOptions {
@@ -39,5 +39,5 @@ export function randBetweenDate<Options extends BetweenOptions = never>(
     );
   };
 
-  return fake(generator, options);
+  return fake(generator, options, dateComparisonFunction);
 }

packages/falso/src/lib/core/core.ts

@@ -95,6 +95,12 @@ export const objectWithIdComparisonFunction: <T extends { id: string }>(
 ) => boolean = (item, items) => {
   return items.some((i) => i.id === item.id);
 };
+export const dateComparisonFunction: (date: Date, dates: Date[]) => boolean = (
+  date,
+  dates
+) => {
+  return dates.some((d) => d.valueOf() === date.valueOf());
+};
 
 export function randElement<T>(arr: T[]): T {
   return arr[Math.floor(random() * arr.length)];

packages/falso/src/lib/credit-card.ts

@@ -81,5 +81,12 @@ export function randCreditCard<Options extends CreditCardOptions = never>(
     };
   };
 
-  return fake(factory, options);
+  return fake(factory, options, comparisonFunction);
 }
+
+export const comparisonFunction: (
+  card: CreditCard,
+  cards: CreditCard[]
+) => boolean = (card, cards) => {
+  return cards.some((c) => c.number === card.number);
+};

packages/falso/src/lib/flight-details.ts

@@ -5,6 +5,7 @@ import { Airline, randFlightNumber } from './flight-number';
 import { randFullName } from './full-name';
 import { randSeatNumber } from './seat-number';
 import { Airport, randAirport } from './airport';
+import { CreditCard } from './credit-card';
 
 export interface FlightDetailsOptions extends FakeOptions {
   airline?: Airline;
@@ -73,3 +74,14 @@ export function randFlightDetails<Options extends FlightDetailsOptions = never>(
 
   return fake(factory, options);
 }
+
+export const comparisonFunction: (
+  flight: FlightDetails,
+  flights: FlightDetails[]
+) => boolean = (flight, flights) => {
+  return flights.some(
+    (f) =>
+      f.passenger + f.flightNumber + f.date ===
+      flight.passenger + flight.flightNumber + flight.date
+  );
+};

packages/falso/src/lib/float.ts

@@ -37,5 +37,3 @@ export function randFloat<Options extends RandomFloatOptions = never>(
   };
   return fake(() => getRandomInRange(o), options);
 }
-
-randFloat();

packages/falso/src/lib/full-address.ts

@@ -1,4 +1,4 @@
-import { FakeOptions, fake } from './core/core';
+import { fake } from './core/core';
 import { AddressOptions, randAddress } from './address';
 
 /**
@@ -29,7 +29,7 @@ export function randFullAddress<Options extends AddressOptions = never>(
   const includeCounty: boolean = options?.includeCounty ?? true;
   const includeCountry: boolean = options?.includeCountry ?? true;
 
-  const factory = () => {
+  const factory: () => string = () => {
     const { street, city, county, country, zipCode } = randAddress({
       includeCounty,
       includeCountry,

packages/falso/src/lib/future-date.ts

@@ -1,5 +1,5 @@
 import { randBetweenDate } from './between-date';
-import { fake, FakeOptions } from './core/core';
+import { dateComparisonFunction, fake, FakeOptions } from './core/core';
 
 interface FutureOptions extends FakeOptions {
   years?: number;
@@ -35,5 +35,7 @@ export function randFutureDate<Options extends FutureOptions = never>(
   const yearsInMilliseconds = years * 365 * 24 * 60 * 60 * 1000;
   const from = new Date();
   const to = new Date(from.getTime() + yearsInMilliseconds);
-  return fake(() => randBetweenDate({ from, to }), options);
+  const factory: () => Date = () => randBetweenDate({ from, to });
+
+  return fake(factory, options, dateComparisonFunction);
 }

packages/falso/src/lib/nearby-gpscoordinate.ts

@@ -19,5 +19,16 @@ import { randLongitude } from './longitude';
 export function randNearbyGPSCoordinate<Options extends FakeOptions = never>(
   options?: Options
 ) {
-  return fake(() => [randLatitude(), randLongitude()], options);
+  return fake(
+    () => [randLatitude(), randLongitude()],
+    options,
+    comparisonFunction
+  );
 }
+
+const comparisonFunction: (
+  coordinate: number[],
+  coordinates: number[][]
+) => boolean = (coordinate, coordinates) => {
+  return coordinates.some((c) => c.join('') === c.join(''));
+};

packages/falso/src/lib/past-date.ts

@@ -1,5 +1,5 @@
 import { randBetweenDate } from './between-date';
-import { fake, FakeOptions } from './core/core';
+import { dateComparisonFunction, fake, FakeOptions } from './core/core';
 
 interface PastOptions extends FakeOptions {
   years?: number;
@@ -36,5 +36,9 @@ export function randPastDate<Options extends PastOptions = never>(
   const to = new Date();
   const from = new Date(to.getTime() - yearsInMilliseconds);
 
-  return fake(() => randBetweenDate({ from, to }), options);
+  return fake(
+    () => randBetweenDate({ from, to }),
+    options,
+    dateComparisonFunction
+  );
 }

packages/falso/src/lib/recent-date.ts

@@ -1,5 +1,5 @@
 import { randBetweenDate } from './between-date';
-import { fake, FakeOptions } from './core/core';
+import { dateComparisonFunction, fake, FakeOptions } from './core/core';
 
 interface RecentOptions extends FakeOptions {
   days?: number;
@@ -36,5 +36,9 @@ export function randRecentDate<Options extends RecentOptions = never>(
   const to = new Date();
   const from = new Date(to.getTime() - daysInMilliseconds);
 
-  return fake(() => randBetweenDate({ from, to }), options);
+  return fake(
+    () => randBetweenDate({ from, to }),
+    options,
+    dateComparisonFunction
+  );
 }

packages/falso/src/lib/soon-date.ts

@@ -1,5 +1,5 @@
 import { randBetweenDate } from './between-date';
-import { fake, FakeOptions } from './core/core';
+import { dateComparisonFunction, fake, FakeOptions } from './core/core';
 
 interface SoonOptions extends FakeOptions {
   days?: number;
@@ -35,5 +35,9 @@ export function randSoonDate<Options extends SoonOptions = never>(
   const daysInMilliseconds = days * 24 * 60 * 60 * 1000;
   const from = new Date();
   const to = new Date(from.getTime() + daysInMilliseconds);
-  return fake(() => randBetweenDate({ from, to }), options);
+  return fake(
+    () => randBetweenDate({ from, to }),
+    options,
+    dateComparisonFunction
+  );
 }

packages/falso/src/lib/todo.ts

@@ -1,4 +1,4 @@
-import { fake, FakeOptions } from './core/core';
+import { fake, FakeOptions, objectWithIdComparisonFunction } from './core/core';
 import { randUuid } from './uuid';
 import { randBoolean } from './boolean';
 import { randText } from './text';
@@ -26,11 +26,11 @@ export interface Todo {
 export function randTodo<Options extends FakeOptions = never>(
   options?: Options
 ) {
-  return fake(() => {
-    return {
-      id: randUuid(),
-      title: randText({ charCount: 40 }),
-      completed: randBoolean(),
-    } as Todo;
-  }, options);
+  const factory: () => Todo = () => ({
+    id: randUuid(),
+    title: randText({ charCount: 40 }),
+    completed: randBoolean(),
+  });
+
+  return fake(factory, options, objectWithIdComparisonFunction);
 }

packages/falso/src/lib/user-name.ts

@@ -34,7 +34,7 @@ export interface UserNameOptions extends FakeOptions {
 export function randUserName<Options extends UserNameOptions = never>(
   options?: Options
 ) {
-  return fake(() => {
+  const factory: () => string = () => {
     const firstName = options?.firstName ?? randFirstName();
     const lastName = options?.lastName ?? randLastName();
     let userName = `${firstName} ${lastName}`.replace(' ', fake(['.', '_']));
@@ -44,5 +44,7 @@ export function randUserName<Options extends UserNameOptions = never>(
     }
 
     return userName;
-  }, options);
+  };
+
+  return fake(factory, options);
 }

packages/falso/src/lib/zip-code.ts

@@ -19,13 +19,15 @@ import { randBoolean } from './boolean';
 export function randZipCode<Options extends FakeOptions = never>(
   options?: Options
 ) {
-  return fake(() => {
+  const factory: () => string = () => {
     let zipCode = '' + randNumber({ min: 10_000, max: 99_999 });
 
     if (randBoolean()) {
       zipCode += '-' + randNumber({ min: 1_000, max: 9_999 });
     }
 
     return zipCode;
-  }, options);
+  };
+
+  return fake(factory, options);
 }