arefathi/Chatter

A simple chat application using Socket io and MongoDB.

API

Table of Contents

• number
  • Parameters
• string
  • Parameters
• connect
• err
• log
• on
  • Parameters
• on
  • Parameters
• on
  • Parameters
• chat
  • Parameters
• join
  • Parameters
• username
• insert
  • Parameters
• insert
  • Parameters
• distinct
  • Parameters
• emit
  • Parameters
• emit
  • Parameters
• emit
  • Parameters
• toArray
  • Parameters
• username
  • Parameters
• message

number

Require MongoDB native node client to keep chat history.

Parameters

• null string 'mongodb'

string

Require Socket.io to use web sockets for the chat clients.

Parameters

• null string 'socket.io'
  • null.listen number (4001)

connect

Connect to MongoDB from localhost to database- chatter.

err

If error in database connection - show error

• Throws DatabaseError

log

If successfully connected, log connection.

on

Connect to Socket Client.

Parameters

• null string 'connection'
• function string (socket)

on

Socket when recieving "add-user" call.

Parameters

• null string "add-user"
• function Array<string> (data)

on

Listen for send-message call from sockets.

Parameters

• null string "send-message"
• null Array<string> (incoming data)

chat

Create or Use Collections

Parameters

• null string 'chats'
• null string 'users'

join

Socket joins to rooms.

Parameters

• null room "public"

username

insert

Insert into collections -users

Parameters

• null-username string
• null-joined_at timestamp timestamp

insert

Insert all chat activities to collection -chats

Parameters

• username string username
• message string content
• towhom string recipient
• sent_at timestamp timestamp

distinct

Fetch unique usernames from users collection

Parameters

• null string "username"

Returns Array<srting> userlist

emit

Send the user list to clients.

Parameters

• null @var 'users'
• userlist Array<string>

emit

Send chat history to connected sockets.

Parameters

• null string 'history'
• null Array<string> 'result'

emit

Emit chat activity to client.

Parameters

• null Array<string> 'output'

toArray

Fetch chat history of both public and private from DB.

Descending Sort,Limit to 10, change to array format for emit

Parameters

• username string
• towhom string
• towhom string

username

Send the incoming message to appropriate room

Parameters

• if private - to intended user
• if public - to all users

Returns emit new message with data

message