Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jackall3n/builder-pattern-faker
https://github.com/jackall3n/builder-pattern-faker
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jackall3n/builder-pattern-faker
- Owner: jackall3n
- License: mit
- Created: 2021-12-07T14:08:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T08:54:05.000Z (about 1 year ago)
- Last Synced: 2024-03-15T12:12:21.952Z (10 months ago)
- Language: TypeScript
- Size: 83 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# builder-pattern
Create a builder pattern for Typescript using ES6 proxy.
## Installation
```
yarn add builder-pattern
```
## Usage
### Basic usage
```typescript
interface UserInfo {
id: number;
userName: string;
email: string;
}
const userInfo = Builder()
.id(1)
.userName('foo')
.email('[email protected]')
.build();
```
A note of caution: when building objects from scratch, the builder currently cannot ensure that all
mandatory fields have been set. The built object might thus violate the contract of the given interface.
For example, the following will compile (see also the example in the tests):
```typescript
const brokenUserInfo = Builder()
.build();
```
A way around this is to use template objects, see next section.
Another way is to use StrictBuilder.
### Usage with template objects
You can also specify a template object, which allows easy creation of variation of objects.
This is especially useful for making test data setup more readable:
```typescript
const defaultUserInfo: UserInfo = {
id: 1,
userName: 'foo',
email: '[email protected]'
};
const modifiedUserInfo = Builder(defaultUserInfo)
.id(2)
.build();
```
Notes:
- With this approach, if the template object conforms to the interface, the
built object will, too.
- The builder will effectively create and modify a shallow copy of the template object.
### Usage with class object
You can also specify a class object.
```typescript
class UserInfo {
id!: number;
userName!: string;
email!: string;
}
const userInfo = Builder(UserInfo) // note that ( ) is used instead of < > here
.id(1)
.userName('foo')
.email('[email protected]')
.build();
```
Moreover, you can also specify a class object with a template object.
```typescript
class UserInfo {
id!: number;
userName!: string;
email!: string;
}
const userInfo = Builder(UserInfo, {id: 1, userName: 'foo'})
.userName:('foo bar')
.email('[email protected]')
.build();
```
### Usage with StrictBuilder
`StrictBuilder` is used to make sure all variables are initialized.
```typescript
interface UserInfo {
id: number;
userName: string;
email: string;
}
const userInfo = StrictBuilder()
.id(1)
.build(); \\ This expression is not callable.
\\ Type 'never' has no call signatures.ts(2349)
```
All variables must be initialized before calling `build()`.
```typescript
const userInfo = StrictBuilder()
.id(1)
.userName('foo')
.email('[email protected]')
.build(); \\ build() is called successfully
```
Notes:
`StrictBuilder` does not support template object nor class.
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Credits
The idea is by unional and jcalz.
Please refer to the [stackoverflow question](https://stackoverflow.com/questions/45291644/builder-pattern-using-typescript-interfaces).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details