From 7ef3e5ab0c00e2ed46e02c4f64c12acc16eb2866 Mon Sep 17 00:00:00 2001 From: Ian Gulliver Date: Sat, 14 Jun 2014 11:05:53 -0700 Subject: [PATCH] Add referenced typedefs. --- externs/cosmopolite.js | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/externs/cosmopolite.js b/externs/cosmopolite.js index e3d770d..7345701 100644 --- a/externs/cosmopolite.js +++ b/externs/cosmopolite.js @@ -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