Adding some comments
This commit is contained in:
1 parent
26e502d896
commit
bb4c62dd38
8 files changed
+40
-6
No files matched your search
@@ -1,5 +1,7 @@
|
||||
exports.newEvents = function newEvents() {
|
||||
|
||||
/*
|
||||
This is the query executed to fill the timeline of a certain User or Bot Profile.
|
||||
*/
|
||||
let thisObject = {
|
||||
profile: undefined,
|
||||
initialIndex: undefined,
|
||||
|
||||
@@ -3,6 +3,9 @@ exports.newPostReplies = function newPostReplies() {
|
||||
Each Post regardless if it is authored by a User or Bot Profile,
|
||||
can have replies. This query is designed for Network Clients to
|
||||
fetch the posts metadata that are replies to a certain post.
|
||||
|
||||
This is the query executed at the Network Client to fill the page
|
||||
of a certain post, with all its replies.
|
||||
*/
|
||||
let thisObject = {
|
||||
profile: undefined,
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
exports.newProfileFollowers = function newProfileFollowers() {
|
||||
|
||||
/*
|
||||
This module represents the query that allows a Network Client to know
|
||||
all the User or Bot profiles that are following a certain User or Bot profile.
|
||||
*/
|
||||
let thisObject = {
|
||||
profile: undefined,
|
||||
initialIndex: undefined,
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
exports.newProfileFollowing = function newProfileFollowing() {
|
||||
|
||||
/*
|
||||
This module represents the query that allows a Network Client to know
|
||||
all the User or Bot profiles that are being followed by a certain User or Bot profile.
|
||||
*/
|
||||
let thisObject = {
|
||||
profile: undefined,
|
||||
initialIndex: undefined,
|
||||
|
||||
@@ -3,6 +3,9 @@ exports.newProfilePosts = function newProfilePosts() {
|
||||
Each User or Bot Profile can have posts. This query
|
||||
is designed for Network Clients to fetch the posts
|
||||
metadata they need from the Social Graph.
|
||||
|
||||
This is the query to be executed to fill a Profile page
|
||||
with all of its posts.
|
||||
*/
|
||||
let thisObject = {
|
||||
profile: undefined,
|
||||
|
||||
@@ -1,4 +1,15 @@
|
||||
/*
|
||||
The Superalgos Network will have 3 types of nodes:
|
||||
|
||||
* Social Graph Nodes
|
||||
* Search Index Nodes
|
||||
* Private Message Nodes
|
||||
|
||||
This module is the starting point of the Social Graph Network Node.
|
||||
|
||||
This type of node is responsible for mantaining the whole Social Graph
|
||||
or relationships between User and Bot profiles and also between their posts.
|
||||
*/
|
||||
|
||||
global.NT = {
|
||||
memory: {
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
exports.newProfileFollowers = function newProfileFollowers() {
|
||||
|
||||
/*
|
||||
This module have a few funcions that are often needed at Queries Modules.
|
||||
*/
|
||||
let thisObject = {
|
||||
profilesValidations: profilesValidations,
|
||||
postValidations: postValidations,
|
||||
|
||||
@@ -1,5 +1,12 @@
|
||||
exports.newClientInterface = function newClientInterface() {
|
||||
/*
|
||||
This module represents the Interface the Network Node have
|
||||
with Network Clients connected to it. There are two things
|
||||
Network Clients can do with this Network Node:
|
||||
|
||||
* Send an Event that happened at the Network Client to the Network.
|
||||
* Make a Query to the Network Node for info needed at the Network Client.
|
||||
*/
|
||||
let thisObject = {
|
||||
eventReceived: eventReceived,
|
||||
queryReceived: queryReceived,
|
||||
@@ -19,7 +26,7 @@ exports.newClientInterface = function newClientInterface() {
|
||||
|
||||
function eventReceived(eventMessage) {
|
||||
/*
|
||||
We expect here a JSON string with the following properties:
|
||||
We expect here a JSON string with some or all of the following properties:
|
||||
|
||||
{
|
||||
"eventId": "a8de78f0-c3e4-4a2a-b7e8-f659073969db",
|
||||
@@ -49,7 +56,7 @@ exports.newClientInterface = function newClientInterface() {
|
||||
|
||||
function queryReceived(queryMessage) {
|
||||
/*
|
||||
We expect here a JSON string with the following properties:
|
||||
We expect here a JSON string with some or all of the following properties:
|
||||
|
||||
{
|
||||
"equeryId": "a8de78f0-c3e4-4a2a-b7e8-f659073969db",
|
||||
|
||||
Reference in new issue
Block a user