eksi-sozluk

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>models/User.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Tutorials</li><li class="nav-item"><a href="tutorial-01-getting-started.html">Getting Started</a></li><li class="nav-item"><a href="tutorial-02-profile.html">Profile</a></li><li class="nav-item"><a href="tutorial-03-trash.html">Trash</a></li><li class="nav-item"><a href="tutorial-04-account.html">Account</a></li><li class="nav-item"><a href="tutorial-05-titles.html">Titles</a></li><li class="nav-item"><a href="tutorial-06-entries-and-drafts.html">Entries & Drafts</a></li><li class="nav-item"><a href="tutorial-07-users.html">Users</a></li><li class="nav-item"><a href="tutorial-08-tags.html">Tags</a></li><li class="nav-item"><a href="tutorial-09-upload-and-delete-image.html">Upload & Delete Image</a></li><li class="nav-item"><a href="tutorial-10-questions.html">Questions</a></li><li class="nav-item"><a href="tutorial-11-miscellaneous.html">Miscellaneous</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="AuthError.html">AuthError</a></li><li class="nav-heading">C<a href="CollectionBase.html">CollectionBase</a></li><li class="nav-item">F<a href="CollectionBase.html#first">first</a></li><li class="nav-item">F<a href="CollectionBase.html#last">last</a></li><li class="nav-item">F<a href="CollectionBase.html#next">next</a></li><li class="nav-item">F<a href="CollectionBase.html#prev">prev</a></li><li class="nav-heading">C<a href="DraftEntry.html">DraftEntry</a></li><li class="nav-item">F<a href="DraftEntry.html#change">change</a></li><li class="nav-item">F<a href="DraftEntry.html#dismiss">dismiss</a></li><li class="nav-item">F<a href="DraftEntry.html#publish">publish</a></li><li class="nav-item">F<a href="DraftEntry.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="DraftTitle.html">DraftTitle</a></li><li class="nav-heading">C<a href="EksiMember.html">EksiMember</a></li><li class="nav-item">F<a href="EksiMember.html#agenda">agenda</a></li><li class="nav-item">F<a href="EksiMember.html#cancelEmailAddressChange">cancelEmailAddressChange</a></li><li class="nav-item">F<a href="EksiMember.html#changeEmailAddress">changeEmailAddress</a></li><li class="nav-item">F<a href="EksiMember.html#changeLoginUsername">changeLoginUsername</a></li><li class="nav-item">F<a href="EksiMember.html#changePassword">changePassword</a></li><li class="nav-item">F<a href="EksiMember.html#createBackup">createBackup</a></li><li class="nav-item">F<a href="EksiMember.html#createEntry">createEntry</a></li><li class="nav-item">F<a href="EksiMember.html#debeEntries">debeEntries</a></li><li class="nav-item">F<a href="EksiMember.html#deleteAccount">deleteAccount</a></li><li class="nav-item">F<a href="EksiMember.html#deleteImage">deleteImage</a></li><li class="nav-item">F<a href="EksiMember.html#drafts">drafts</a></li><li class="nav-item">F<a href="EksiMember.html#emptyTrash">emptyTrash</a></li><li class="nav-item">F<a href="EksiMember.html#entries">entries</a></li><li class="nav-item">F<a href="EksiMember.html#entryById">entryById</a></li><li class="nav-item">F<a href="EksiMember.html#events">events</a></li><li class="nav-item">F<a href="EksiMember.html#followedUserFavoriteEntries">followedUserFavoriteEntries</a></li><li class="nav-item">F<a href="EksiMember.html#followedUserTitles">followedUserTitles</a></li><li class="nav-item">F<a href="EksiMember.html#isEmailAddressInChangeStatus">isEmailAddressInChangeStatus</a></li><li class="nav-item">F<a href="EksiMember.html#isNewEventExist">isNewEventExist</a></li><li class="nav-item">F<a href="EksiMember.html#isNewMessageExist">isNewMessageExist</a></li><li class="nav-item">F<a href="EksiMember.html#me">me</a></li><li class="nav-item">F<a href="EksiMember.html#pinEntry">pinEntry</a></li><li class="nav-item">F<a href="EksiMember.html#questionsInAgenda">questionsInAgenda</a></li><li class="nav-item">F<a href="EksiMember.html#questionsInToday">questionsInToday</a></li><li class="nav-item">F<a href="EksiMember.html#removePin">removePin</a></li><li class="nav-item">F<a href="EksiMember.html#retrieve">retrieve</a></li><li class="nav-item">F<a href="EksiMember.html#rookieTitles">rookieTitles</a></li><li class="nav-item">F<a href="EksiMember.html#search">search</a></li><li class="nav-item">F<a href="EksiMember.html#tags">tags</a></li><li class="nav-item">F<a href="EksiMember.html#titlesByTag">titlesByTag</a></li><li class="nav-item">F<a href="EksiMember.html#today">today</a></li><li class="nav-item">F<a href="EksiMember.html#todayInHistory">todayInHistory</a></li><li class="nav-item">F<a href="EksiMember.html#trashEntries">trashEntries</a></li><li class="nav-item">F<a href="EksiMember.html#untaggedTitles">untaggedTitles</a></li><li class="nav-item">F<a href="EksiMember.html#uploadImage">uploadImage</a></li><li class="nav-item">F<a href="EksiMember.html#user">user</a></li><li class="nav-heading">C<a href="EksiSozluk.html">EksiSozluk</a></li><li class="nav-item">F<a href="EksiSozluk.html#agenda">agenda</a></li><li class="nav-item">F<a href="EksiSozluk.html#createToken">createToken</a></li><li class="nav-item">F<a href="EksiSozluk.html#debeEntries">debeEntries</a></li><li class="nav-item">F<a href="EksiSozluk.html#entries">entries</a></li><li class="nav-item">F<a href="EksiSozluk.html#entryById">entryById</a></li><li class="nav-item">F<a href="EksiSozluk.html#isAuthenticated">isAuthenticated</a></li><li class="nav-item">F<a href="EksiSozluk.html#isRecaptchaRequired">isRecaptchaRequired</a></li><li class="nav-item">F<a href="EksiSozluk.html#login">login</a></li><li class="nav-item">F<a href="EksiSozluk.html#loginWithToken">loginWithToken</a></li><li class="nav-item">F<a href="EksiSozluk.html#questionsInAgenda">questionsInAgenda</a></li><li class="nav-item">F<a href="EksiSozluk.html#questionsInToday">questionsInToday</a></li><li class="nav-item">F<a href="EksiSozluk.html#search">search</a></li><li class="nav-item">F<a href="EksiSozluk.html#tags">tags</a></li><li class="nav-item">F<a href="EksiSozluk.html#titlesByTag">titlesByTag</a></li><li class="nav-item">F<a href="EksiSozluk.html#todayInHistory">todayInHistory</a></li><li class="nav-item">F<a href="EksiSozluk.html#untaggedTitles">untaggedTitles</a></li><li class="nav-item">F<a href="EksiSozluk.html#user">user</a></li><li class="nav-heading">C<a href="Entry.html">Entry</a></li><li class="nav-item">F<a href="Entry.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="EntryCollection.html">EntryCollection</a></li><li class="nav-item">F<a href="EntryCollection.html#createEntry">createEntry</a></li><li class="nav-item">F<a href="EntryCollection.html#first">first</a></li><li class="nav-item">F<a href="EntryCollection.html#last">last</a></li><li class="nav-item">F<a href="EntryCollection.html#next">next</a></li><li class="nav-item">F<a href="EntryCollection.html#prev">prev</a></li><li class="nav-item">F<a href="EntryCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="EntryForMember.html">EntryForMember</a></li><li class="nav-item">F<a href="EntryForMember.html#deleteFromTrash">deleteFromTrash</a></li><li class="nav-item">F<a href="EntryForMember.html#downvote">downvote</a></li><li class="nav-item">F<a href="EntryForMember.html#favorite">favorite</a></li><li class="nav-item">F<a href="EntryForMember.html#listFavoritedAuthors">listFavoritedAuthors</a></li><li class="nav-item">F<a href="EntryForMember.html#listFavoritedRookies">listFavoritedRookies</a></li><li class="nav-item">F<a href="EntryForMember.html#recoverFromTrash">recoverFromTrash</a></li><li class="nav-item">F<a href="EntryForMember.html#removevote">removevote</a></li><li class="nav-item">F<a href="EntryForMember.html#retrieve">retrieve</a></li><li class="nav-item">F<a href="EntryForMember.html#unfavorite">unfavorite</a></li><li class="nav-item">F<a href="EntryForMember.html#upvote">upvote</a></li><li class="nav-heading">C<a href="FollowedUserFavoriteEntry.html">FollowedUserFavoriteEntry</a></li><li class="nav-heading">C<a href="FollowedUserTitle.html">FollowedUserTitle</a></li><li class="nav-heading">C<a href="Image.html">Image</a></li><li class="nav-heading">C<a href="ImageCollection.html">ImageCollection</a></li><li class="nav-item">F<a href="ImageCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="NotFoundError.html">NotFoundError</a></li><li class="nav-heading">C<a href="Question.html">Question</a></li><li class="nav-heading">C<a href="SearchResults.html">SearchResults</a></li><li class="nav-item">F<a href="SearchResults.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="Tag.html">Tag</a></li><li class="nav-heading">C<a href="TagForMember.html">TagForMember</a></li><li class="nav-item">F<a href="TagForMember.html#follow">follow</a></li><li class="nav-item">F<a href="TagForMember.html#unfollow">unfollow</a></li><li class="nav-heading">C<a href="Title.html">Title</a></li><li class="nav-heading">C<a href="TitleCollection.html">TitleCollection</a></li><li class="nav-item">F<a href="TitleCollection.html#first">first</a></li><li class="nav-item">F<a href="TitleCollection.html#last">last</a></li><li class="nav-item">F<a href="TitleCollection.html#next">next</a></li><li class="nav-item">F<a href="TitleCollection.html#prev">prev</a></li><li class="nav-item">F<a href="TitleCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="TrashEntry.html">TrashEntry</a></li><li class="nav-item">F<a href="TrashEntry.html#deleteFromTrash">deleteFromTrash</a></li><li class="nav-item">F<a href="TrashEntry.html#downvote">downvote</a></li><li class="nav-item">F<a href="TrashEntry.html#favorite">favorite</a></li><li class="nav-item">F<a href="TrashEntry.html#listFavoritedAuthors">listFavoritedAuthors</a></li><li class="nav-item">F<a href="TrashEntry.html#listFavoritedRookies">listFavoritedRookies</a></li><li class="nav-item">F<a href="TrashEntry.html#recoverFromTrash">recoverFromTrash</a></li><li class="nav-item">F<a href="TrashEntry.html#removevote">removevote</a></li><li class="nav-item">F<a href="TrashEntry.html#retrieve">retrieve</a></li><li class="nav-item">F<a href="TrashEntry.html#unfavorite">unfavorite</a></li><li class="nav-item">F<a href="TrashEntry.html#upvote">upvote</a></li><li class="nav-heading">C<a href="UkteCollection.html">UkteCollection</a></li><li class="nav-item">F<a href="UkteCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="User.html">User</a></li><li class="nav-item">F<a href="User.html#entries">entries</a></li><li class="nav-item">F<a href="User.html#favoriteAuthors">favoriteAuthors</a></li><li class="nav-item">F<a href="User.html#favoritedEntries">favoritedEntries</a></li><li class="nav-item">F<a href="User.html#favorites">favorites</a></li><li class="nav-item">F<a href="User.html#images">images</a></li><li class="nav-item">F<a href="User.html#lastVotedEntries">lastVotedEntries</a></li><li class="nav-item">F<a href="User.html#mostLikedEntries">mostLikedEntries</a></li><li class="nav-item">F<a href="User.html#retrieve">retrieve</a></li><li class="nav-item">F<a href="User.html#selfFavoritedEntries">selfFavoritedEntries</a></li><li class="nav-item">F<a href="User.html#ukteler">ukteler</a></li><li class="nav-heading">C<a href="UserEntryCollection.html">UserEntryCollection</a></li><li class="nav-item">F<a href="UserEntryCollection.html#first">first</a></li><li class="nav-item">F<a href="UserEntryCollection.html#last">last</a></li><li class="nav-item">F<a href="UserEntryCollection.html#next">next</a></li><li class="nav-item">F<a href="UserEntryCollection.html#prev">prev</a></li><li class="nav-item">F<a href="UserEntryCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="UserFavoriteAuthorCollection.html">UserFavoriteAuthorCollection</a></li><li class="nav-item">F<a href="UserFavoriteAuthorCollection.html#retrieve">retrieve</a></li><li class="nav-heading">C<a href="UserForMember.html">UserForMember</a></li><li class="nav-item">F<a href="UserForMember.html#block">block</a></li><li class="nav-item">F<a href="UserForMember.html#blockTitles">blockTitles</a></li><li class="nav-item">F<a href="UserForMember.html#clearNote">clearNote</a></li><li class="nav-item">F<a href="UserForMember.html#entries">entries</a></li><li class="nav-item">F<a href="UserForMember.html#favoriteAuthors">favoriteAuthors</a></li><li class="nav-item">F<a href="UserForMember.html#favoritedEntries">favoritedEntries</a></li><li class="nav-item">F<a href="UserForMember.html#favorites">favorites</a></li><li class="nav-item">F<a href="UserForMember.html#follow">follow</a></li><li class="nav-item">F<a href="UserForMember.html#images">images</a></li><li class="nav-item">F<a href="UserForMember.html#lastVotedEntries">lastVotedEntries</a></li><li class="nav-item">F<a href="UserForMember.html#mostLikedEntries">mostLikedEntries</a></li><li class="nav-item">F<a href="UserForMember.html#retrieve">retrieve</a></li><li class="nav-item">F<a href="UserForMember.html#selfFavoritedEntries">selfFavoritedEntries</a></li><li class="nav-item">F<a href="UserForMember.html#sendMessage">sendMessage</a></li><li class="nav-item">F<a href="UserForMember.html#setNote">setNote</a></li><li class="nav-item">F<a href="UserForMember.html#ukteler">ukteler</a></li><li class="nav-item">F<a href="UserForMember.html#unblock">unblock</a></li><li class="nav-item">F<a href="UserForMember.html#unblockTitles">unblockTitles</a></li><li class="nav-item">F<a href="UserForMember.html#unfollow">unfollow</a></li><li class="nav-heading">C<a href="VoteError.html">VoteError</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">M<a href="global.html#COLLECTION_TYPES">COLLECTION_TYPES</a></li><li class="nav-item">M<a href="global.html#TAGS">TAGS</a></li><li class="nav-item">M<a href="global.html#TITLE_TYPES">TITLE_TYPES</a></li> </nav> <div id="main"> <h1 class="page-title">models/User.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>const UserEntryCollection = require('./UserEntryCollection') const ImageCollection = require('./ImageCollection') const UserFavoriteAuthorCollection = require('./UserFavoriteAuthorCollection') const UkteCollection = require('./UkteCollection') const { URLS } = require('../constants') /** * User. */ class User { /** * User ID. * * @type {(number|null)} */ id = null /** * Tag URL. * * @type {string} */ username /** * User URL. * * @type {string} */ url /** * @typedef UserBadge * @property {string} name Badge name. * @property {(string|null)} description Badge description. */ /** * Badge list. * * @type {Array<UserBadge>} */ badges /** * Badge points. * * @type {number} */ badgePoints /** * Total entry count. * * @type {number} */ entryCountTotal /** * Last month entry count. * * @type {number} */ entryCountLastmonth /** * Last week entry count. * * @type {number} */ entryCountLastweek /** * Today entry count. * * @type {number} */ entryCountToday /** * Last entry time. * * @type {(string|null)} */ lastEntryTime /** * Is user followed? * * @type {(boolean|null)} */ isFollowed = null /** * Is user blocked? * * @type {(boolean|null)} */ isBlocked = null /** * Is user titles blocked? * * @type {(boolean|null)} */ isTitlesBlocked = null /** * User note. * * @type {(string|null)} */ note = null /** * Create user. * * @param {object} request Axios client. * @param {string} username Username. * @param {string} [cookies=null] Cookie string. */ constructor (request, username, cookies = null) { this._request = request this._cookies = cookies this.username = username } /** * Parse properties with given document. * * @param {object} $ Cheerio document. * @param {object} [elm=null] Cheerio element. * @ignore */ serialize ($, elm = null) { // start - split badges const badges = [] let badgePoints = null const badgeCount = $('ul#user-badges li').length $('ul#user-badges li').each((i, elm) => { if (i === badgeCount - 1) { // last badge const badgeText = $(elm).text() const badge = badgeText.replace(/[0-9]|$|$/g, '').trim() badges.push({ name: badge, description: null }) // scrape badge points badgePoints = parseInt(badgeText.replace(/^.*?(\d+).*/, '$1')) || 0 } else { badges.push({ name: $(elm).text(), description: $(elm) .find('a') .attr('title') }) } }) // end - split badges const lastEntryTime = $('ul li#last-entry-time') .text() .trim() this.username = $('h1#user-profile-title a').text() this.url = URLS.USER + this.username this.badges = badges this.badgePoints = badgePoints this.entryCountTotal = parseInt($('ul li#entry-count-total').text()) this.entryCountLastmonth = parseInt($('ul li#entry-count-lastmonth').text()) this.entryCountLastweek = parseInt($('ul li#entry-count-lastweek').text()) this.entryCountToday = parseInt($('ul li#entry-count-today').text()) this.lastEntryTime = lastEntryTime === '' ? null : lastEntryTime const isAuth = this._cookies // bind auth properties if (isAuth) { const note = $('#user-note').text() this.id = parseInt($('#who').attr('value')) this.isFollowed = $('#buddy-link').data('added') || false this.isBlocked = $('#blocked-link').data('added') || false this.isTitlesBlocked = $('#blocked-index-title-link').data('added') || false this.note = note === '' ? null : note } } /** * Retrieve user. * * @returns {Promise} Promise. */ retrieve () { return new Promise((resolve, reject) => { // make username url ready const username = this.username.replace(' ', '-') const requestOptions = { endpoint: `/biri/${username}`, cookie: this._cookies, resourceName: 'User' } this._request(requestOptions, $ => { this.serialize($) resolve() }) }) } /** * Fetch user entries by latest. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by last posted. */ async entries (options) { const entries = new UserEntryCollection( this._request, URLS.USER_LATEST_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * Fetch user favorite entries by latest. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by last favorited. */ async favorites (options) { const entries = new UserEntryCollection( this._request, URLS.USER_FAVORITE_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * Fetch user favorited entries by most favorited. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by most favorited. */ async favoritedEntries (options) { const entries = new UserEntryCollection( this._request, URLS.USER_MOST_FAVORITE_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * Fetch user last voted entries. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by last voted. */ async lastVotedEntries (options) { const entries = new UserEntryCollection( this._request, URLS.USER_LAST_VOTED_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * Fetch user self favorited entries. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by self favorited. */ async selfFavoritedEntries (options) { const entries = new UserEntryCollection( this._request, URLS.USER_SELF_FAVORITE_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * Fetch user most liked entries. * * @param {object} options Parameters that user can specify. * @param {number} [options.page=1] Page number. * @returns {Promise.<UserEntryCollection>} User entries by most liked. */ async mostLikedEntries (options) { const entries = new UserEntryCollection( this._request, URLS.USER_MOST_LIKED_ENTRIES, this.username, this._cookies, options ) await entries.retrieve() return entries } /** * User images. * * @returns {ImageCollection} User images. */ async images () { const images = new ImageCollection(this._request, this.username) await images.retrieve() return images } /** * Fetch user favorite authors until last one month. * * @returns {UserFavoriteAuthorCollection} User favorite authors. */ async favoriteAuthors () { const collection = new UserFavoriteAuthorCollection( this._request, this.username, this._cookies ) await collection.retrieve() return collection } /** * Fetch ukteler. * * @returns {UkteCollection} User ukteler. */ async ukteler () { const collection = new UkteCollection( this._request, this.username, this._cookies ) await collection.retrieve() return collection } } module.exports = User </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Sun Aug 29 2021 03:27:00 GMT+0300 (GMT+03:00) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>