Source: reminder.js

  1. /** @module Models */
  3. const ObjectID = require('bson-objectid');
  5. /**
  6.  * Class that represents a Reminder used when creating a {@link Task}. The reminder
  7.  * will go off at {propertiesOrQty} {units} before the date set for the {@link Task}. Or at  the
  8.  * specified {propertiesOrQty.trigger}.
  9.  * @class
  10.  * @param {Object|Number} propertiesOrQty - Properties of the {@link Reminder} or the quantity of
  11.  * time before the start date in which the reminder will trigger
  12.  * @param {string=} propertiesOrQty.id - Object ID of the Reminder, only defined when this is an
  13.  * instantiation of a pre-existing reminder. On new reminders this must be empty in order
  14.  * to generate a new ObjectID
  15.  * @param {string=} propertiesOrQty.trigger - Custom trigger in the pre-defined format
  16.  * /^TRIGGER:-?PT[0-9]+[SMHD]$/
  17.  * @param {Reminder.TimeUnit} unit - Unit of time
  18.  */
  19. function Reminder(propertiesOrQty, unit) {
  20.   if (unit === undefined) {
  21.     this.id = propertiesOrQty.id || ObjectID();
  22.     this.trigger = propertiesOrQty.trigger || 'TRIGGER:PT0S';
  23.   } else {
  24.     let unitChar;
  25.     if (unit === Reminder.TimeUnit.SECONDS) {
  26.       unitChar = 'S';
  27.     } else if (unit === Reminder.TimeUnit.MINUTES) {
  28.       unitChar = 'M';
  29.     } else if (unit === Reminder.TimeUnit.HOURS) {
  30.       unitChar = 'H';
  31.     } else if (unit === Reminder.TimeUnit.DAYS) {
  32.       unitChar = 'D';
  33.     } else {
  34.       throw new Reminder.InvalidUnitError();
  35.     }
  37.     this.id = ObjectID();
  38.     this.trigger = `TRIGGER:-PT${propertiesOrQty}${unitChar}`;
  39.   }
  40. }
  42. /**
  43.  * Enum for the time unit used in the creation of a reminder
  44.  * @readonly
  45.  * @enum {Number}
  46.  */
  47. Reminder.TimeUnit = {
  48.   /** Used when the reminder is set in seconds */
  49.   SECONDS: 0,
  50.   /** Used when the reminder is set in minutes */
  51.   MINUTES: 1,
  52.   /** Used when the reminder is set in hours */
  53.   HOURS: 2,
  54.   /** Used when the reminder is set in days */
  55.   DAYS: 3,
  56. };
  58. /**
  59.  * Error thrown when a call to create a {@link Reminder} is made
  60.  * with an invalid time unit parameter.
  61.  * @class
  62.  * @ignore
  63.  */
  64. Reminder.InvalidUnitError = class extends Error {
  65.   constructor(unit) {
  66.     super(`The unit "${unit}" is invalid`);
  67.   }
  68. };
  70. module.exports = Reminder;
  72. // Reminder structure from api response
  73. // {
  74. //   id: '5c342818e4b04a7154bfea3a',
  75. //   trigger: 'TRIGGER:PT0S',
  76. // }