https://github.com/romansky/backbone-typed
Run-time type support for backbone models
https://github.com/romansky/backbone-typed
Last synced: 4 months ago
JSON representation
Run-time type support for backbone models
- Host: GitHub
- URL: https://github.com/romansky/backbone-typed
- Owner: romansky
- Created: 2012-09-13T13:18:36.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2014-04-12T13:02:13.000Z (about 12 years ago)
- Last Synced: 2025-10-30T21:38:00.621Z (8 months ago)
- Language: CoffeeScript
- Size: 151 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
backbone-typed [](https://travis-ci.org/romansky/backbone-typed)
==============
Run-time type support for backbone models
Backbone-Typed extends the Backbone model and provides an optional Type system on top of the default models.
The system is provided in run time, and is optimistic, if the value can be converted to the needed type it will, if not, it will be nulled and logged
Examples writtein in Coffee-Script but source is compiled to JS so no need to have CS installed at run time.
## Installation
npm install backbone-typed
## Usage
typed = require 'backbone-typed'
TypedModel = typed.TypedModel
Types = typed.Types
### Features
```coffeescript
enumLike : {
"OPTION_1"
"OPTION_2"
"OPTION_3"
"OPTION_4"
}
class MyTypedModel extends TypedModel
defaults : {
param1: null,
param2: null,
param3: null
}
types : {
param1: Types.String,
param2: Types.Integer,
param3: Types.Enum(enumLike)
}
myTypedModel = new MyTypedModel({param1: "im a string", param2: "1337", param3: enumLike.OPTION_1})
console.log myTypedModel.toJSON()
=> { param1: "im a string", param2: 1337, param3: "OPTION_1" }
# now things get interesting...
myTypedModel2 = new MyTypedModel({param1: 100, param2: "bzzzz", param3: "NOT A REAL OPTION"})
console.log myTypedModel2.toJSON()
=> backbone-typed :: 2012-9-13 20:10:3.235 :: ERROR :: backbone-typed nulled value of:"param2" value:"bzzzz" type:"Integer"
=> backbone-typed :: 2012-9-13 20:10:3.235 :: ERROR :: backbone-typed nulled value of:"param3" value:"NOT A REAL OPTION" type:"Enum"
=> { param1: "100", param2: null, param3: null }
```
### Creating your own type!
Sometimes its useful to have your own method that validates input and returns some output.
Backbone-typed provides a method that "signs" the passed function, so that we know its there in purpose, and will even return its name if the ".toString()" of said function is called.
```coffeescript
# we sign the function
myType = typed.signTypeFunction "Custom",(param)->
return if param is "its me!" then "yes" else null
# now use it in a model
class CustomTyped extends TypedModel
defaults : { testMe : null }
types : { testMe : myType }
```
More examples in specs.
## Future
Libraries of additional types
## License
MIT