Skip to content

An implementation of Google Maps' MVCObject for Node.js and browers

License

Notifications You must be signed in to change notification settings

wyntau/MVCObject

Repository files navigation

MVCObject NPM version Build Status Dependencies Status

An implementation of Google Maps' MVCObject for Node.js and browers.

This is a standalone class - you can use it in any of your JavaScript applications, it doesn't have to be Google Maps related.

mvcobject

APIs

Methods Return Value Description
bindTo(key: string, target: MVCObject, targetKey?: string, noNotify?: boolean) this Binds a View to a Model.
changed(key: string) ? Generic handler for state changes. Override this in derived classes to handle arbitrary state changes.
get(key: string) * Gets a value.
notify(key: string) this Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.
set(key: string, value: any) this Sets a value.
setValues(values: object) this Sets a collection of key-value pairs.
unbind(key: string) this Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.
unbindAll() this Removes all bindings.
addListener(eventName: string, handler: Function) EventListener add listener for ${key}_changed event
addListenerOnce(eventName: string, handler: Function) EventListener add listener for ${key}_changed event once
removeListener(eventListener: EventListener) void remove event listener

Usage

  • ES6

    import MVCObject from 'mvcobject'
    
    class Foo extends MVCObject{
        constructor(){
            super()
        }
    }
  • ES5

    var MVCObject = require('mvcobject').MVCObject;
    function Foo(){}
    Foo.prototype = new MVCObject();

test

Thanks to @twpayne, the test suites are based on his mvcobject_test.js.

npm install
npm run test

LICENSE

The MIT License (MIT)

Copyright (c) 2013 - present Wyntau wyntau@outlook.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

An implementation of Google Maps' MVCObject for Node.js and browers

Resources

License

Stars

Watchers

Forks

Packages

No packages published