https://github.com/vincentdchan/bananacollection

A typescript style data structure which implement C# like event and collection.
https://github.com/vincentdchan/bananacollection

Last synced: about 1 month ago
JSON representation

A typescript style data structure which implement C# like event and collection.

• Host: GitHub
• URL: https://github.com/vincentdchan/bananacollection
• Owner: vincentdchan
• License: mit
• Created: 2015-11-22T12:34:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-22T12:56:10.000Z (almost 9 years ago)
• Last Synced: 2024-04-24T05:16:13.806Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Banana Collection

Banana Collection is a collection written in Typescript of data structures for web development.

BC is typed. It should be used in Typescript. BC tries to implement

some functions in Backbone

# Usage

## Event

### class Event\

```

var evt: BC.Event = new BC.event;

```

### Event::on( (modelType, argsType) => void )

Event::on is equal to Event::bind

```

evt.on((m: string, args: any) => {

    console.log(m);

    console.log(args.time);

});

```

### Event::trigger(modelType, argsType)

```

console.log(new Date());

setTimeout( () =>{ evt.trigger("times up", {time: new Date()}) }, 3);

```

## Model

### class Model

here is an example

```

class User extends Model {

    event_sync: Event;

    private _name: string

    constructor(name: string) {

        this._name = name;

    }

    get name(): string {

        return this._name;

    }

    set name(newName: string) {

        this._name = newName;

        this.event_changed.trigger(this, {

            changedKey: "name",

            changedValue: newName

        });

    }

    sync(): {

        // do something to sync

        this.event_synv.trigger(this, null);

    }

}

```

I recommend that the name of event property of subclass of Model

should start with `event_`.

### Embedded property

 - cid: number

 - event_changed: Event\

 - event_error: Event\

 - event_invalid: Event\

## Collection

### class Collection\

There are some embedded properties

 - event_add: Event\, any\>;

 - event_remove: Event\, any\>;

 - event_update: Event\, any\>;

 - event_sort: Event\, any\>;

### Collection::add(T, AddOption?): void

`options` takes two property.

when options.at is set, the object whould be inserted at the position.

when options.merge is set, the object would be merged to the original object

in the collection with the same cid

### Collection::each((obj: T) => void)

iterate each object in the collection.

### Collection::max((a: T, b: T) => number): T

return the max item in the collection according to the comparator.

A comparator is passed to the function.

if a > b, the comparator should return a number > 0.

if a == b, the comparator should return a number == 0.

if a < b, the comparator should return a number <0.

### Collection::min((a: T, b: T) => number): T

return the min item in the collection according to the comparator.

### Collection::push(T): void

push an item to the end of the collection.

### Collection::pop(): T

return and remove the last item of the collection.

### Collection::shift(): T

return and remove the first item of the collection.

### Collection::at(number): T

return the item of the collection by the index is given.

### Collection::remove(T)

remove the item in the collection which has the same cid of the object is given

### Collection::getById(number)

return the item has the cid which is given.

### Collection::length

a property return the length of the collection.