Monday, 3 April 2017

JSDoc Warning: unresolved variable or type

In my user.model.js I have JSDoc @returns w stated as unresolved variable or type, how can I solve this warnings (if possible ..)

serSchema.statics = {
  /**
   * Get user
   * @param {ObjectId} id - The objectId of user.
   * @returns {Promise<User, APIError>}.  !!!!!  WARNING on User
   */
  get(id) {
    return this.findById(id)
      .exec()
      .then((user) => {
        if (user) {
          return user;
        }
        const err = new APIError('No such user exists!', httpStatus.NOT_FOUND);
        return Promise.reject(err);
      });
  },

  /**
   * List users in descending order of 'createdAt' timestamp.
   * @param {number} skip - Number of users to be skipped.
   * @param {number} limit - Limit number of users to be returned.
   * @returns {Promise<User[]>}.   !!!!!   WARNING on User
   */
  list({ skip = 0, limit = 50 } = {}) {
    return this.find()
      .sort({ createdAt: -1 })
      .skip(skip)
      .limit(limit)
      .exec();
  }
};

/**
 * @typedef User.    !!!!!   WARNING on User
 */
export default mongoose.model('User', UserSchema);



via erwin

No comments:

Post a Comment