Add referenced typedefs.

This commit is contained in:
Ian Gulliver
2014-06-14 11:05:53 -07:00
parent fb0d695d6e
commit 7ef3e5ab0c

View File

@@ -6,6 +6,45 @@
* @author ian@cosmopolite.org (Ian Gulliver)
*/
/**
* @see https://www.cosmopolite.org/reference#callbacks
* @typedef {{onConnect: (function()|undefined),
* onDisconnect: (function()|undefined),
* onLogin: (function(string, string)|undefined),
* onLogout: (function(string)|undefined),
* onMessage: (function(Cosmopolite.typeMessage)|undefined),
* onPin: (function(Cosmopolite.typeMessage)|undefined),
* onUnpin: (function(Cosmopolite.typeMessage)|undefined)}}
*/
Cosmopolite.typeCallbacks;
/**
* @see https://www.cosmopolite.org/reference#message
* @typedef {{event_type: string,
* id: number,
* created: number,
* sender: string,
* subject: Cosmopolite.typeSubject,
* message: *}}
*/
Cosmopolite.typeMessage;
/**
* @see https://www.cosmopolite.org/reference#subject
* @typedef {{name: string,
* readable_only_by: (string|undefined),
* writable_only_by: (string|undefined)}}
*/
Cosmopolite.typeSubject;
/** @typedef {(Cosmopolite.typeSubject|string|number)} */
Cosmopolite.typeSubjectLoose;
/**
* @see https://www.cosmopolite.org/reference#constructor
* @constructor