https://github.com/oliverbenns/factori

A minimal Factory pattern in Typescript.
https://github.com/oliverbenns/factori

factory factory-bot factory-girl factory-pattern jest-tests typescript

Last synced: 14 days ago
JSON representation

A minimal Factory pattern in Typescript.

• Host: GitHub
• URL: https://github.com/oliverbenns/factori
• Owner: oliverbenns
• License: mit
• Created: 2020-04-28T20:46:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-30T09:17:38.000Z (over 3 years ago)
• Last Synced: 2024-12-04T19:39:50.769Z (about 1 month ago)
• Topics: factory, factory-bot, factory-girl, factory-pattern, jest-tests, typescript
• Language: TypeScript
• Homepage:
• Size: 642 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Factori

A minimal Factory pattern in Typescript.

## Installation

```

npm install factori --save

```

## Documentation

Simple docs for a simple library.

```typescript

import Factory from "factori";

interface Product {

	id: number;

	name: string;

}

// Create a factory

const productFactory = new Factory({

	id: 1,

	name: "Apple",

});

// Create a single object with overridden properties

// { id: 1, name: "Orange" }

const a = productFactory.create({

	name: "Orange",

});

// Create a single object with an anon function that allows editing of the original.

// { id: 2, name: "Apple Juice" }

const b = productFactory.create((product) => ({

	id: product.id + 1,

	name: `${product.name} Juice`,

}));

// Create an array of objects

// [{ id: 1, name: "Apple" }, { id: 1, name: "Apple" }]

const c = productFactory.createList(2);

// Create an array of objects with overridden properties

// [{ id: 1, name: "Orange" }, { id: 1, name: "Orange" }]

const d = productFactory.createList(2, {

	name: "Orange",

});

// Create an array of objects with an anon function that allows editing of the original.

// This is useful for incremental fields, like ids/keys.

// [{ id: 0, name: "Orange Juice" }, { id: 1, name: "Orange Juice" }]

const e = productFactory.createList(2, (product, index) => ({

	id: index,

	name: `${product.name} Juice`,

}));

```

## Roadmap

_Someday…_

- Adding option to deep copy. This would fix nested object references which would be shared across instances. Disabled by default for performance reasons.

- Adding incremental fields to auto-increment, e.g. `{ id: new Incrementor(i => i + 1) }`. This would allow easier incremental updates on all methods as the only way to do that currently is to create an array and use the index in the map function. However the objects do become less predictable this way, especially with concurrent operations.