WebDev/VersaWhiteboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore: added doc on new classes

Browse Source
This commit is contained in:
Florent Chehab 2020-05-11 17:54:41 +02:00
parent 203e35b3e4
commit 00f7b10ac9
No known key found for this signature in database
GPG Key ID: 9A0CE018889EA246
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
scripts/WhiteboardServerSideInfo.js
View File

@ -1,5 +1,8 @@
const config = require("./config/config"); const config = require("./config/config");
/**
* Class to hold information related to a whiteboard
*/
class WhiteboardServerSideInfo { class WhiteboardServerSideInfo {
static defaultScreenResolution = { w: 1000, h: 1000 }; static defaultScreenResolution = { w: 1000, h: 1000 };

3
src/js/services/ConfigService.js
View File

@ -1,5 +1,8 @@
import { getThrottling } from "./ConfigService.utils"; import { getThrottling } from "./ConfigService.utils";
/**
* Class to hold the configuration sent by the backend
*/
class ConfigService { class ConfigService {
/** /**
* @type {object} * @type {object}

3
src/js/services/ThrottlingService.js
View File

@ -2,6 +2,9 @@ import Point from "../classes/Point";
import { getCurrentTimeMs } from "../utils"; import { getCurrentTimeMs } from "../utils";
import ConfigService from "./ConfigService"; import ConfigService from "./ConfigService";
/**
* Class to handle all the throttling logic
*/
class ThrottlingService { class ThrottlingService {
/** /**
* @type {number} * @type {number}