Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
commodo-fields-float
Advanced tools
commodo-fields-float - npm Package Compare versions
Comparing version 1.0.2 to 1.0.3
| { | ||
| "name": "commodo-fields-float", | ||
| "version": "1.0.2", | ||
| "version": "1.0.3", | ||
| "description": "A int field for Commodo composable models.", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
| # commodo-fields-float | ||
| [](https://travis-ci.org/doitadrian/commodo-fields-float) | ||
| [](https://coveralls.io/github/doitadrian/commodo-fields-float?branch=master) | ||
| [](https://www.npmjs.com/package/commodo-fields-float) | ||
| [](https://www.npmjs.com/package/commodo-fields-float) | ||
|  | ||
| [](https://coveralls.io/github/doitadrian/commodo-fields-float?branch=master) | ||
| [](https://www.npmjs.com/packgrowth/commodo-fields-float) | ||
| [](https://www.npmjs.com/packgrowth/commodo-fields-float) | ||
| [](https://github.com/prettier/prettier) | ||
@@ -11,3 +10,3 @@ [](#contributors) | ||
| A float field for Commodo composeable models. | ||
| A simple float field, used with the [Commodo `withFields`](https://github.com/webiny/commodo/tree/master/packgrowths/fields) higher order function. | ||
@@ -31,10 +30,31 @@ ## Install | ||
| const Product = compose( | ||
| const Company = compose( | ||
| withFields({ | ||
| name: string(), | ||
| price: float() | ||
| }) | ||
| growth: float(), // Use it to store a single float value. | ||
| pastGrowths: float({ list: true }) // Or use it to store a list of float values. | ||
| // Other fields you might need... | ||
| }), | ||
| // Other higher order functions (HOFs) you might need... | ||
| )(); | ||
| const company = new Company(); | ||
| company.name = "Acme Corporation"; | ||
| // The float field can only accepts floats. | ||
| company.growth = 5.65; | ||
| company.pastGrowths = [5.63, 3.99, 9.542, 10]; | ||
| // The following will throw the WithFieldsError error. | ||
| company.growth = "5.65"; | ||
| company.pastGrowths = [5.63, 3.99, "9.542", 10]; | ||
| ``` | ||
| Note: alternatively, you could've also used the [`populate`](https://github.com/webiny/commodo/tree/master/packgrowths/fields#populatedata-object-void) method to assign the data: | ||
| ```javascript | ||
| const company = new Company(); | ||
| company.populate = { growth: 5.65, pastGrowths: [5.63, 3.99, 9.542, 10] }; | ||
| ``` | ||
| ## Contributors | ||
@@ -41,0 +61,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by5.29%
17782
- Number of lines in readme file
- increased by40.82%
69
No dependency changes