Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@MyMediaMagnet
MyMediaMagnet committed Mar 20, 2018
1 parent 070bb5c commit f456b4c
Showing 1 changed file with 78 additions and 79 deletions.
157 changes: 78 additions & 79 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Javascript enabled Models and Collections to reflect Laravel workflow

## Installation

`npm install model-collection-js`
`npm install model-collection-js`

## Usage
(Would appreciate advice on allowing easier imports without folder structure)
Expand All @@ -18,111 +18,110 @@ Javascript enabled Models and Collections to reflect Laravel workflow

##### Some of the most basic usage
```es6
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let some_array = [1, 2, 3, 4]
let collection = new Collection(some_array)
collection.first() // 1
collection.last() // 4
collection.nth(1) // 2 (basically just the index of the list)
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let some_array = [1, 2, 3, 4]
let collection = new Collection(some_array)
collection.first() // 1
collection.last() // 4
collection.nth(1) // 2 (basically just the index of the list)
```
##### Adding and Removing items from the collection
```es6
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.add({id: 5, name: 'Fourth'}) // returns Collection with new item added
collection.remove({id: 1, name: 'First'}) // returns Collection item removed
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.add({id: 5, name: 'Fourth'}) // returns Collection with new item added
collection.remove({id: 1, name: 'First'}) // returns Collection item removed
```
##### Using where's
```es6
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.where('name', '=', 'First').get() // returns filtered Collection
collection.where('name', '=', 'First').exists() // returns true/false
collection.where('name', '=', 'First').first() // returns {id: 1, name: 'First'}
collection.where('name', '=', 'Third').count() // returns 2
collection.where('name', '=', 'Third').where('id', 3).count() // returns 1
collection.where('name', '=', 'Third').where('id', 1).count() // returns 0
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.where('name', '=', 'First').get() // returns filtered Collection
collection.where('name', '=', 'First').exists() // returns true/false
collection.where('name', '=', 'First').first() // returns {id: 1, name: 'First'}
collection.where('name', '=', 'Third').count() // returns 2
collection.where('name', '=', 'Third').where('id', 3).count() // returns 1
collection.where('name', '=', 'Third').where('id', 1).count() // returns 0
```
##### Sorting the collection
```es6
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.sort('name', 'DESC') // return sorted Collection
collection.sort('name', 'ASC') // return sorted Collection
collection.sortByDate('date', 'DESC') // return sorted Collection
collection.sortByDate('date', 'ASC') // return sorted Collection
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.sort('name', 'DESC') // return sorted Collection
collection.sort('name', 'ASC') // return sorted Collection
collection.sortByDate('date', 'DESC') // return sorted Collection
collection.sortByDate('date', 'ASC') // return sorted Collection
```
##### Other Helpers
```es6
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.each(function(item, key){
// Perform an action on each item in the collection
})
// The find method is a method most useful when collecting objects with an 'id'
collection.find(3) // Return {id:3, name: 'Third'}
collection.find(1) // Return {id:1, name: 'First'}
collection.find('Second', 'name') // Return {id:2, name: 'Second'} (you can override the primary key if you want)
import Collection from 'model-collection-js/dist/classes/collection/Collection'
let array = [
{id: 1, name: 'First'},
{id: 2, name: 'Second'},
{id: 3, name: 'Third'},
{id: 4, name: 'Third'}
]
let collection = new Collection(array)
collection.each(function(item, key){
// Perform an action on each item in the collection
})
// The find method is a method most useful when collecting objects with an 'id'
collection.find(3) // Return {id:3, name: 'Third'}
collection.find(1) // Return {id:1, name: 'First'}
collection.find('Second', 'name') // Return {id:2, name: 'Second'} (you can override the primary key if you want)
```
### Model
```es6
Setup a basic model by extending the Model class

import Model from 'model-collection-js/dist/models/Model'
class User extends Model {
constructor(data) {
super(data)
}
```es6
import Model from 'model-collection-js/dist/models/Model'
class User extends Model {
constructor(data) {
super(data)
}
}

let user_data = {id: 1, name: 'Some Name'}
let user_data = {id: 1, name: 'Some Name'}

let user = new User(user_data)
user.name // returns 'Some Name'
let user = new User(user_data)
user.name // returns 'Some Name'
```
You can also collect an array of data and make the entire collection an instance of the given model
```es6
import Model from 'model-collection-js/dist/models/Model'
class User extends Model {
constructor(data) {
super(data)
}
import Model from 'model-collection-js/dist/models/Model'
class User extends Model {
constructor(data) {
super(data)
}
}

let user_data = [{id: 1, name: 'Some Name'}, {id: 1, name: 'Some Other Name'}]
let users = User.collect(user_data)
users.first() // returns User model
users.first().name // returns 'Some Name'
users.last().name // returns 'Some Other Name'
let user_data = [{id: 1, name: 'Some Name'}, {id: 1, name: 'Some Other Name'}]
let users = User.collect(user_data)
users.first() // returns User model
users.first().name // returns 'Some Name'
users.last().name // returns 'Some Other Name'
```

## Tests

`npm test` or `npm run cover`
`npm test` or `npm run cover`

## Contributing

Expand Down

0 comments on commit f456b4c

Please sign in to comment.