Create a builder pattern for Typescript using ES6 proxy.
yarn add builder-pattern
interface UserInfo {
id: number;
userName: string;
email: string;
}
const userInfo = Builder<UserInfo>()
.id(1)
.userName('Vincent')
.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):
const brokenUserInfo = Builder<UserInfo>()
.build();
A way around this is to use template objects, see next section.
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:
const defaultUserInfo: UserInfo = {
id: 1,
userName: 'foo',
email: '[email protected]'
};
const modifiedUserInfo = Builder(defaultUserInfo)
.id(2)
.build();
Note that with this approach, if the template object conforms to the interface, the built object will, too.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
The idea is by unional and jcalz.
Please refer to the stackoverflow question.
This project is licensed under the MIT License - see the LICENSE file for details