API Documentation

Source

api/interest/InterestTypeCollection.ts

  1. import _ from 'lodash';
  2. import BaseTypeCollection from '../base/BaseTypeCollection';
  3. import { TypeDefine, TypeUpdate } from '../../typings/radgrad';
  5. /**
  6.  * InterestTypes help organize Interests into logically related groupings such as "CS-Disciplines", "Locations", etc.
  7.  * @extends api/base.BaseTypeCollection
  8.  * @memberOf api/interest
  9.  */
  10. class InterestTypeCollection extends BaseTypeCollection {
  12.   /**
  13.    * Creates the InterestType collection.
  14.    */
  15.   constructor() {
  16.     super('InterestType');
  17.   }
  19.   /**
  20.    * Defines a new InterestType with its name, slug, and description.
  21.    * @example
  22.    * InterestTypes.define({ name: 'Locations', slug: 'locations', description: 'Regions of interest.' });
  23.    * @param { Object } description Object with keys name, slug, and description.
  24.    * Slug must be globally unique and previously undefined.
  25.    * @throws { Meteor.Error } If the slug already exists.
  26.    * @returns The newly created docID.
  27.    */
  28.   public define({ name, slug, description, retired = false }: TypeDefine) {
  29.     return super.define({ name, slug, description, retired });
  30.   }
  32.   /**
  33.    * Update an InterestType.
  34.    * @param docID the docID to be updated.
  35.    * @param name the new name (optional).
  36.    * @param description the new description (optional).
  37.    * @throws { Meteor.Error } If docID is not defined.
  38.    */
  39.   public update(docID, { name, description, retired }: TypeUpdate) {
  40.     this.assertDefined(docID);
  41.     const updateData: TypeUpdate = {};
  42.     if (!_.isNil(name)) {
  43.       updateData.name = name;
  44.     }
  45.     if (!_.isNil(description)) {
  46.       updateData.description = description;
  47.     }
  48.     if (_.isBoolean(retired)) {
  49.       updateData.retired = retired;
  50.     }
  51.     this.collection.update(docID, { $set: updateData });
  52.     return true;
  53.   }
  55. }
  57. /**
  58.  * Provides the singleton instance of this class to all other entities.
  59.  * @type {api/interest.InterestTypeCollection}
  60.  * @memberOf api/interest
  61.  */
  62. export const InterestTypes = new InterestTypeCollection();