Skip to content

Commit

Permalink
Documented max, min options of Number type
Browse files Browse the repository at this point in the history
  • Loading branch information
raiyankamal committed Jun 18, 2016
1 parent 3905f5d commit 31c2812
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,20 @@ Returns a random object created from [SimpleSchema](http://github.com/aldeed/met
},
available: {
type: Boolean
},
price: {
type: Number,
max: 100,
min: 25
}
});
var fakeDoc = Fake.simpleSchemaDoc(BookSchema);
// { "title": "Tendy Orbiter", "pages": 112, "available": true }
// { "title": "Tendy Orbiter", "pages": 112, "available": true, "price": 42 }

Only `Number`, `String` and `Boolean` type fields are supported at the moment.

The `max` and `min` options are respected for `Number` type.

## History

This package is forked from `anti:fake`. I forked it and added some modifications to support simple schema docs generation.

0 comments on commit 31c2812

Please sign in to comment.