commodo-fields-int


A simple integer field, used with the Commodo withFields higher order function.

Install

``
npm install --save commodo-fields-int
`

Or if you prefer yarn:
`
yarn add commodo-fields-int
`

Quick Example:



`javascript
import { compose } from "ramda";
import { withFields, string } from "@commodo/fields";
import { int } from "commodo-fields-int";

const Company = compose(
withFields({
name: string(),
age: int(), // Use it to store a single integer value.
topYears: int({ list: true }) // Or use it to store a list of integer values.
// Other fields you might need...
}),
// Other higher order functions (HOFs) you might need...
)();

const company = new Company();
company.name = "Acme Corporation";

// The int field can only accepts integers.
company.age = 17;
company.topYears = [2000, 2005, 2010];

// The following will throw the WithFieldsError error.
company.age = "17";
company.age = 16.2;
company.topYears = [2000, "2005", 2010];
`

Note: alternatively, you could've also used the populate method to assign the data:

`javascript
const company = new Company();
company.populate = { age: 17, topYears: [2000, 2005, 2010] };
``

Contributors

Thanks goes to these wonderful people (emoji key):

|
_{Adrian Smijulj}
💻 📖 💡 👀 ⚠️ |
| :---: |

This project follows the all-contributors specification. Contributions of any kind welcome!