❤
npm
Sign UpSign In

mongoose-feeditems

0.0.3 • Public • Published

Mongoose FeedItems

A simple news feed system for a mongoose.js backed node.js application.

How it works

Creates a FeedItem collection whose documents have the following attributes:

  • actor - the user who caused the feed item to be created
  • createdAt - a timestamp of when the item was created
  • sourceId - the mongoDB id of the source item
  • sourceType - the name of the collection containing the source item

Adds methods and callbacks to other models which create and remove feedItems when they are created or destroyed.

Example

# 
# Setup models 
# 
 
mongooseFeeditems = require("mongoose-feeditems")
 
mongoose = require("mongoose")
 
ThingToTrackSchema = mongoose.Schema.new
  name: 'String'
 
ThingToTrackSchema.plugin mongooseFeedItem.tracker, feedCollection: 'FeedItem'
 
mongoose.model 'ThingToTrack', ThingToTrackSchema
 
 
FeedItemSchema = mongoose.Schema.new()
 
FeedItemSchema.plugin mongooseFeedItem.feedCollection
 
# 
# Use em 
#   
ThingToTrack = mongoose.model("ThingToTrack")
FeedItem = mongoose.model("FeedItem")
 
thing = new ThingToTrack
  name: 'Fish'
 
thing.save (err) ->
  console.log 'thing saved!'
 
  FeedItem.find({}).exec (err, feedItems) ->
    console.log 'feedItems', feedItems # => will contain a feedItem with the source set to the thing. 
 
    feedItems[0].fetchSource (err, source) ->
 
      console.log 'source', source # => will print the thing  
 
 
 

Readme

Keywords

Package Sidebar

Install

npm i mongoose-feeditems

Repository

bitbucket.org/pearlshare/mongoose-feeditems

Homepage

bitbucket.org/pearlshare/mongoose-feeditems#readme

Weekly Downloads

1

Version

0.0.3

License

MIT

Last publish

Collaborators

  • oliverbrooks
Try on RunKit
Report malware