https://github.com/sylvainpolletvillard/ObjectModel

Strong Dynamically Typed Object Modeling for JavaScript
https://github.com/sylvainpolletvillard/ObjectModel

composition dynamic javascript model strong structure type-checking typing

Last synced: about 14 hours ago
JSON representation

Strong Dynamically Typed Object Modeling for JavaScript

• Host: GitHub
• URL: https://github.com/sylvainpolletvillard/ObjectModel
• Owner: sylvainpolletvillard
• License: mit
• Created: 2015-01-11T17:37:57.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-14T16:28:50.000Z (6 months ago)
• Last Synced: 2024-05-15T11:37:39.021Z (6 months ago)
• Topics: composition, dynamic, javascript, model, strong, structure, type-checking, typing
• Language: JavaScript
• Homepage: http://objectmodel.js.org
• Size: 4.94 MB
• Stars: 467
• Watchers: 12
• Forks: 30
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Strong Dynamically Typed Object Modeling for JavaScript



  

  

  

  



---

## What is this library ?

   

  ObjectModel intends to bring **strong dynamic type checking** to your web applications. Contrary to static type-checking solutions like [TypeScript] or [Flow], ObjectModel can also validate data at runtime: JSON from the server, form inputs, content from localStorage, external libraries...

  

  By leveraging **ES6 Proxies**, this library ensures that your variables always match the model definition and validation constraints you added to them. Thanks to the generated exceptions, it will help you spot potential bugs and save you time spent on debugging. ObjectModel is also very easy to master: *no new language to learn, no new tools, no compilation step, just a minimalist and intuitive API in a plain old JS micro-library*.

  

  Validating at runtime also brings many other benefits: you can define your own types, use them in complex model definitions with custom assertions that can even change depending on your application state. Actually it goes much further than just type safety. Go on and see for yourself.

## Installation

Add the library to your project dependencies with NPM:

```bash

$ npm install objectmodel

```

or just [download the library from Github][github-releases]

## Basic usage example

```javascript

import { ObjectModel } from "objectmodel"

const Order = new ObjectModel({

	product: { name: String, quantity: Number },

	orderDate: Date

});

const myOrder = new Order({

	product: { name: "Apple Pie", quantity: 1 },

	orderDate: new Date()

});

myOrder.product.quantity = 2; // no exceptions thrown

myOrder.product.quantity = false; //try to assign a Boolean

// ❌ TypeError: expecting product.quantity to be Number, got Boolean false

```

## Documentation

For more examples, documentation and questions, please refer to the project website: [objectmodel.js.org][website]

## Changelog and Release History

Please refer to [Github Releases][github-releases]

*Bug reports and pull requests are welcome.*

Distributed under the MIT license. See ``LICENSE`` for more information.

[website]:http://objectmodel.js.org

[TypeScript]:https://www.typescriptlang.org/

[Flow]:https://flowtype.org/

[github-releases]:https://github.com/sylvainpolletvillard/ObjectModel/releases

[npm-url]: https://npmjs.org/package/objectmodel

[npm-image]: https://img.shields.io/npm/v/objectmodel.svg

[npm-downloads]: https://img.shields.io/npm/dm/objectmodel.svg

[license-badge]:https://img.shields.io/badge/license-MIT-blue.svg