musora-content-services 2.79.0 → 2.80.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. package/.coderabbit.yaml +0 -0
  2. package/.editorconfig +0 -0
  3. package/.github/pull_request_template.md +0 -0
  4. package/.github/workflows/conventional-commits.yaml +0 -0
  5. package/.github/workflows/docs.js.yml +0 -0
  6. package/.github/workflows/node.js.yml +0 -0
  7. package/.prettierignore +0 -0
  8. package/.prettierrc +0 -0
  9. package/CHANGELOG.md +14 -0
  10. package/README.md +0 -0
  11. package/babel.config.cjs +0 -0
  12. package/docs/Content.html +269 -0
  13. package/docs/ContentOrganization.html +2 -2
  14. package/docs/Forums.html +2 -2
  15. package/docs/Gamification.html +2 -2
  16. package/docs/TestUser.html +2 -2
  17. package/docs/UserManagementSystem.html +2 -2
  18. package/docs/api_types.js.html +2 -2
  19. package/docs/config.js.html +2 -2
  20. package/docs/content-org_content-org.js.html +2 -2
  21. package/docs/content-org_guided-courses.ts.html +2 -2
  22. package/docs/content-org_learning-paths.ts.html +124 -24
  23. package/docs/content-org_playlists-types.js.html +2 -2
  24. package/docs/content-org_playlists.js.html +2 -2
  25. package/docs/content.js.html +2 -2
  26. package/docs/content_artist.ts.html +212 -0
  27. package/docs/content_content.ts.html +77 -0
  28. package/docs/content_genre.ts.html +211 -0
  29. package/docs/content_instructor.ts.html +203 -0
  30. package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
  31. package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
  32. package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
  33. package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
  34. package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
  35. package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
  36. package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
  37. package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
  38. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
  39. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
  40. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
  41. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
  42. package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
  43. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
  44. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
  45. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
  46. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
  47. package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
  48. package/docs/forums_categories.ts.html +3 -3
  49. package/docs/forums_discussions.js.html +0 -0
  50. package/docs/forums_forum.js.html +0 -0
  51. package/docs/forums_forums.ts.html +2 -2
  52. package/docs/forums_posts.ts.html +22 -3
  53. package/docs/forums_threads.ts.html +16 -3
  54. package/docs/gamification_awards.js.html +0 -0
  55. package/docs/gamification_awards.ts.html +2 -2
  56. package/docs/gamification_gamification.js.html +2 -2
  57. package/docs/gamification_types.js.html +0 -0
  58. package/docs/global.html +2 -2
  59. package/docs/index.html +2 -2
  60. package/docs/liveTesting.ts.html +2 -2
  61. package/docs/module-Accounts.html +10 -10
  62. package/docs/module-Artist.html +991 -0
  63. package/docs/module-Awards.html +2 -2
  64. package/docs/module-Categories.html +0 -0
  65. package/docs/module-Config.html +2 -2
  66. package/docs/module-Content-Services-V2.html +2 -2
  67. package/docs/module-ForumCategories.html +0 -0
  68. package/docs/module-ForumDiscussions.html +0 -0
  69. package/docs/module-Forums.html +731 -89
  70. package/docs/module-Genre.html +981 -0
  71. package/docs/module-GuidedCourses.html +2 -2
  72. package/docs/module-Instructor.html +929 -0
  73. package/docs/module-Interests.html +2 -2
  74. package/docs/module-LearningPaths.html +640 -12
  75. package/docs/module-Onboarding.html +2 -2
  76. package/docs/module-Payments.html +2 -2
  77. package/docs/module-Permissions.html +2 -2
  78. package/docs/module-Playlists.html +2 -2
  79. package/docs/module-ProgressRow.html +2 -2
  80. package/docs/module-Railcontent-Services.html +2 -2
  81. package/docs/module-Sanity-Services.html +327 -1855
  82. package/docs/module-Sessions.html +2 -2
  83. package/docs/module-Threads.html +0 -0
  84. package/docs/module-UserActivity.html +2 -2
  85. package/docs/module-UserChat.html +2 -2
  86. package/docs/module-UserManagement.html +2 -2
  87. package/docs/module-UserMemberships.html +2 -2
  88. package/docs/module-UserNotifications.html +2 -2
  89. package/docs/module-UserProfile.html +2 -2
  90. package/docs/progress-row_method-card.js.html +8 -7
  91. package/docs/railcontent.js.html +2 -2
  92. package/docs/sanity.js.html +109 -268
  93. package/docs/scripts/collapse.js +0 -0
  94. package/docs/scripts/commonNav.js +0 -0
  95. package/docs/scripts/linenumber.js +0 -0
  96. package/docs/scripts/nav.js +0 -0
  97. package/docs/scripts/polyfill.js +0 -0
  98. package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
  99. package/docs/scripts/prettify/lang-css.js +0 -0
  100. package/docs/scripts/prettify/prettify.js +0 -0
  101. package/docs/scripts/search.js +0 -0
  102. package/docs/styles/jsdoc.css +0 -0
  103. package/docs/styles/prettify.css +0 -0
  104. package/docs/userActivity.js.html +2 -2
  105. package/docs/user_account.ts.html +5 -11
  106. package/docs/user_chat.js.html +2 -2
  107. package/docs/user_interests.js.html +2 -2
  108. package/docs/user_management.js.html +2 -2
  109. package/docs/user_memberships.js.html +0 -0
  110. package/docs/user_memberships.ts.html +2 -2
  111. package/docs/user_notifications.js.html +2 -2
  112. package/docs/user_onboarding.ts.html +2 -2
  113. package/docs/user_payments.ts.html +2 -2
  114. package/docs/user_permissions.js.html +2 -2
  115. package/docs/user_profile.js.html +2 -2
  116. package/docs/user_sessions.js.html +2 -2
  117. package/docs/user_types.js.html +2 -2
  118. package/docs/user_user-management-system.js.html +2 -2
  119. package/jest.config.js +0 -0
  120. package/jsdoc.json +1 -0
  121. package/package.json +1 -1
  122. package/src/contentMetaData.js +0 -0
  123. package/src/contentTypeConfig.js +2 -2
  124. package/src/filterBuilder.js +0 -0
  125. package/src/index.d.ts +28 -5
  126. package/src/index.js +28 -5
  127. package/src/infrastructure/http/HttpClient.ts +0 -0
  128. package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
  129. package/src/infrastructure/http/index.ts +0 -0
  130. package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
  131. package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
  132. package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
  133. package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
  134. package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
  135. package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
  136. package/src/lib/httpHelper.js +0 -0
  137. package/src/lib/lastUpdated.js +0 -0
  138. package/src/services/api/types.js +0 -0
  139. package/src/services/api/types.ts +0 -0
  140. package/src/services/config.js +0 -0
  141. package/src/services/content/artist.ts +139 -0
  142. package/src/services/content/content.ts +38 -0
  143. package/src/services/content/genre.ts +139 -0
  144. package/src/services/content/instructor.ts +131 -0
  145. package/src/services/content-org/content-org.js +0 -0
  146. package/src/services/content-org/guided-courses.ts +0 -0
  147. package/src/services/content-org/learning-paths.ts +35 -21
  148. package/src/services/content-org/playlists-types.js +0 -0
  149. package/src/services/content-org/playlists.js +0 -0
  150. package/src/services/content.js +0 -0
  151. package/src/services/contentLikes.js +0 -0
  152. package/src/services/contentProgress.js +0 -0
  153. package/src/services/dataContext.js +0 -0
  154. package/src/services/dateUtils.js +0 -0
  155. package/src/services/eventsAPI.js +0 -0
  156. package/src/services/forums/forums.ts +0 -0
  157. package/src/services/forums/posts.ts +0 -0
  158. package/src/services/forums/threads.ts +0 -0
  159. package/src/services/forums/types.ts +0 -0
  160. package/src/services/gamification/awards.ts +0 -0
  161. package/src/services/gamification/gamification.js +0 -0
  162. package/src/services/imageSRCBuilder.js +0 -0
  163. package/src/services/imageSRCVerify.js +0 -0
  164. package/src/services/liveTesting.ts +0 -0
  165. package/src/services/progress-row/method-card.js +0 -0
  166. package/src/services/railcontent.js +0 -0
  167. package/src/services/recommendations.js +0 -0
  168. package/src/services/sanity.js +105 -266
  169. package/src/services/types.js +0 -0
  170. package/src/services/user/account.ts +3 -9
  171. package/src/services/user/chat.js +0 -0
  172. package/src/services/user/interests.js +0 -0
  173. package/src/services/user/management.js +0 -0
  174. package/src/services/user/memberships.ts +0 -0
  175. package/src/services/user/notifications.js +0 -0
  176. package/src/services/user/onboarding.ts +0 -0
  177. package/src/services/user/payments.ts +0 -0
  178. package/src/services/user/permissions.js +0 -0
  179. package/src/services/user/profile.js +0 -0
  180. package/src/services/user/sessions.js +0 -0
  181. package/src/services/user/types.js +0 -0
  182. package/src/services/user/user-management-system.js +0 -0
  183. package/src/services/userActivity.js +0 -0
  184. package/test/HttpClient.test.js +0 -0
  185. package/test/content.test.js +0 -0
  186. package/test/contentLikes.test.js +0 -0
  187. package/test/contentProgress.test.js +0 -0
  188. package/test/dataContext.test.js +0 -0
  189. package/test/forum.test.js +0 -0
  190. package/test/imageSRCBuilder.test.js +0 -0
  191. package/test/imageSRCVerify.test.js +0 -0
  192. package/test/initializeTests.js +0 -0
  193. package/test/learningPaths.test.js +0 -0
  194. package/test/lib/lastUpdated.test.js +0 -0
  195. package/test/live/contentProgressLive.test.js +0 -0
  196. package/test/live/railcontentLive.test.js +0 -0
  197. package/test/localStorageMock.js +0 -0
  198. package/test/log.js +0 -0
  199. package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
  200. package/test/mockData/mockData_progress_content.json +0 -0
  201. package/test/mockData/mockData_sanity_progress_content.json +0 -0
  202. package/test/mockData/mockData_user_practices.json +0 -0
  203. package/test/notifications.test.js +0 -0
  204. package/test/progressRows.test.js +0 -0
  205. package/test/sanityQueryService.test.js +0 -0
  206. package/test/streakMessage.test.js +0 -0
  207. package/test/user/permissions.test.js +0 -0
  208. package/test/userActivity.test.js +0 -0
  209. package/tools/generate-index.cjs +0 -0
  210. package/.claude/settings.local.json +0 -14
  211. package/.yarnrc.yml +0 -1
package/docs/module-Instructor.html ADDED
@@ -0,0 +1,929 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>Instructor - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
29
+ <nav >
30
+
31
+
32
+ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~markThreadAsRead">markThreadAsRead</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
+
34
+ </nav>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">Instructor</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+
51
+
52
+ </header>
53
+
54
+ <article>
55
+
56
+ <div class="container-overview">
57
+
58
+
59
+
60
+
61
+
62
+ </div>
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <h3 class="subsection-title">Methods</h3>
81
+
82
+
83
+
84
+
85
+
86
+
87
+ <h4 class="name" id="~fetchInstructorBySlug"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchInstructorBySlug<span class="signature">(slug, brand<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;Instructor>>}</span></h4>
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dl class="details">
95
+
96
+ <dt class="tag-description">Description:</dt>
97
+ <dd class="tag-description"><ul class="dummy"><li>Fetch a single instructor by their name</li></ul></dd>
98
+
99
+
100
+
101
+ <dt class="tag-source">Source:</dt>
102
+ <dd class="tag-source"><ul class="dummy"><li>
103
+ <a href="content_instructor.ts.html">content/instructor.ts</a>, <a href="content_instructor.ts.html#line42">line 42</a>
104
+ </li></ul></dd>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <h5 class="h5-examples">Example</h5>
149
+
150
+ <pre class="prettyprint"><code>fetchInstructorBySlug('66samus', 'drumeo')
151
+ .then(instructor => console.log(instructor))
152
+ .catch(error => console.error(error));</code></pre>
153
+
154
+
155
+
156
+
157
+ <h5 class="h5-parameters">Parameters:</h5>
158
+
159
+
160
+ <table class="params">
161
+ <thead>
162
+ <tr>
163
+
164
+ <th>Name</th>
165
+
166
+
167
+ <th>Type</th>
168
+
169
+
170
+ <th>Attributes</th>
171
+
172
+
173
+
174
+
175
+ <th class="last">Description</th>
176
+ </tr>
177
+ </thead>
178
+
179
+ <tbody>
180
+
181
+
182
+ <tr>
183
+
184
+ <td class="name"><code>slug</code></td>
185
+
186
+
187
+ <td class="type">
188
+
189
+
190
+ <span class="param-type">string</span>
191
+
192
+
193
+
194
+
195
+ </td>
196
+
197
+
198
+ <td class="attributes">
199
+
200
+
201
+
202
+
203
+
204
+ </td>
205
+
206
+
207
+
208
+
209
+ <td class="description last">The slug of the instructor to fetch.</td>
210
+ </tr>
211
+
212
+
213
+
214
+ <tr>
215
+
216
+ <td class="name"><code>brand</code></td>
217
+
218
+
219
+ <td class="type">
220
+
221
+
222
+ <span class="param-type">string</span>
223
+
224
+
225
+
226
+
227
+ </td>
228
+
229
+
230
+ <td class="attributes">
231
+
232
+ &lt;optional><br>
233
+
234
+
235
+
236
+
237
+
238
+ </td>
239
+
240
+
241
+
242
+
243
+ <td class="description last">The brand for which to fetch the instructor. Lesson count will be filtered by this brand if provided.</td>
244
+ </tr>
245
+
246
+
247
+ </tbody>
248
+ </table>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+ <h5 class="h5-returns">Returns:</h5>
266
+
267
+
268
+ <div class="param-desc">
269
+ - A promise that resolves to an instructor object or null if not found.
270
+ </div>
271
+
272
+
273
+
274
+ <dl class="param-type">
275
+ <dt>
276
+ Type
277
+ </dt>
278
+ <dd>
279
+
280
+ <span class="param-type">Promise.&lt;Array.&lt;Instructor>></span>
281
+
282
+
283
+
284
+ </dd>
285
+ </dl>
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+ <h4 class="name" id="~fetchInstructorLessons"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchInstructorLessons<span class="signature">(brand, slug, options)</span><span class="type-signature"> &rarr; {Promise.&lt;InstructorLessonsResponse>}</span></h4>
297
+
298
+
299
+
300
+
301
+
302
+
303
+ <dl class="details">
304
+
305
+ <dt class="tag-description">Description:</dt>
306
+ <dd class="tag-description"><ul class="dummy"><li>Fetch the data needed for the instructor screen.</li></ul></dd>
307
+
308
+
309
+
310
+ <dt class="tag-source">Source:</dt>
311
+ <dd class="tag-source"><ul class="dummy"><li>
312
+ <a href="content_instructor.ts.html">content/instructor.ts</a>, <a href="content_instructor.ts.html#line87">line 87</a>
313
+ </li></ul></dd>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ </dl>
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+ <h5 class="h5-examples">Example</h5>
358
+
359
+ <pre class="prettyprint"><code>fetchInstructorLessons('instructor123')
360
+ .then(lessons => console.log(lessons))
361
+ .catch(error => console.error(error));</code></pre>
362
+
363
+
364
+
365
+
366
+ <h5 class="h5-parameters">Parameters:</h5>
367
+
368
+
369
+ <table class="params">
370
+ <thead>
371
+ <tr>
372
+
373
+ <th>Name</th>
374
+
375
+
376
+ <th>Type</th>
377
+
378
+
379
+
380
+
381
+
382
+ <th class="last">Description</th>
383
+ </tr>
384
+ </thead>
385
+
386
+ <tbody>
387
+
388
+
389
+ <tr>
390
+
391
+ <td class="name"><code>brand</code></td>
392
+
393
+
394
+ <td class="type">
395
+
396
+
397
+ <span class="param-type">string</span>
398
+
399
+
400
+
401
+
402
+ </td>
403
+
404
+
405
+
406
+
407
+
408
+ <td class="description last">The brand for which to fetch instructor lessons</td>
409
+ </tr>
410
+
411
+
412
+
413
+ <tr>
414
+
415
+ <td class="name"><code>slug</code></td>
416
+
417
+
418
+ <td class="type">
419
+
420
+
421
+ <span class="param-type">string</span>
422
+
423
+
424
+
425
+
426
+ </td>
427
+
428
+
429
+
430
+
431
+
432
+ <td class="description last">The slug of the instructor</td>
433
+ </tr>
434
+
435
+
436
+
437
+ <tr>
438
+
439
+ <td class="name"><code>options</code></td>
440
+
441
+
442
+ <td class="type">
443
+
444
+
445
+ <span class="param-type">FetchInstructorLessonsOptions</span>
446
+
447
+
448
+
449
+
450
+ </td>
451
+
452
+
453
+
454
+
455
+
456
+ <td class="description last">Parameters for pagination, filtering and sorting.
457
+ <h6>Properties</h6>
458
+
459
+
460
+ <table class="params">
461
+ <thead>
462
+ <tr>
463
+
464
+ <th>Name</th>
465
+
466
+
467
+ <th>Type</th>
468
+
469
+
470
+ <th>Attributes</th>
471
+
472
+
473
+
474
+ <th>Default</th>
475
+
476
+
477
+ <th class="last">Description</th>
478
+ </tr>
479
+ </thead>
480
+
481
+ <tbody>
482
+
483
+
484
+ <tr>
485
+
486
+ <td class="name"><code>sortOrder</code></td>
487
+
488
+
489
+ <td class="type">
490
+
491
+
492
+ <span class="param-type">string</span>
493
+
494
+
495
+
496
+
497
+ </td>
498
+
499
+
500
+ <td class="attributes">
501
+
502
+ &lt;optional><br>
503
+
504
+
505
+
506
+
507
+
508
+ </td>
509
+
510
+
511
+
512
+ <td class="default">
513
+
514
+ <code>"-published_on"</code>
515
+
516
+ </td>
517
+
518
+
519
+ <td class="description last">The field to sort the lessons by.</td>
520
+ </tr>
521
+
522
+
523
+
524
+ <tr>
525
+
526
+ <td class="name"><code>searchTerm</code></td>
527
+
528
+
529
+ <td class="type">
530
+
531
+
532
+ <span class="param-type">string</span>
533
+
534
+
535
+
536
+
537
+ </td>
538
+
539
+
540
+ <td class="attributes">
541
+
542
+ &lt;optional><br>
543
+
544
+
545
+
546
+
547
+
548
+ </td>
549
+
550
+
551
+
552
+ <td class="default">
553
+
554
+ <code>""</code>
555
+
556
+ </td>
557
+
558
+
559
+ <td class="description last">The search term to filter content by title.</td>
560
+ </tr>
561
+
562
+
563
+
564
+ <tr>
565
+
566
+ <td class="name"><code>page</code></td>
567
+
568
+
569
+ <td class="type">
570
+
571
+
572
+ <span class="param-type">number</span>
573
+
574
+
575
+
576
+
577
+ </td>
578
+
579
+
580
+ <td class="attributes">
581
+
582
+ &lt;optional><br>
583
+
584
+
585
+
586
+
587
+
588
+ </td>
589
+
590
+
591
+
592
+ <td class="default">
593
+
594
+ <code>1</code>
595
+
596
+ </td>
597
+
598
+
599
+ <td class="description last">The page number for pagination.</td>
600
+ </tr>
601
+
602
+
603
+
604
+ <tr>
605
+
606
+ <td class="name"><code>limit</code></td>
607
+
608
+
609
+ <td class="type">
610
+
611
+
612
+ <span class="param-type">number</span>
613
+
614
+
615
+
616
+
617
+ </td>
618
+
619
+
620
+ <td class="attributes">
621
+
622
+ &lt;optional><br>
623
+
624
+
625
+
626
+
627
+
628
+ </td>
629
+
630
+
631
+
632
+ <td class="default">
633
+
634
+ <code>10</code>
635
+
636
+ </td>
637
+
638
+
639
+ <td class="description last">The number of items per page.</td>
640
+ </tr>
641
+
642
+
643
+
644
+ <tr>
645
+
646
+ <td class="name"><code>includedFields</code></td>
647
+
648
+
649
+ <td class="type">
650
+
651
+
652
+ <span class="param-type">Array.&lt;string></span>
653
+
654
+
655
+
656
+
657
+ </td>
658
+
659
+
660
+ <td class="attributes">
661
+
662
+ &lt;optional><br>
663
+
664
+
665
+
666
+
667
+
668
+ </td>
669
+
670
+
671
+
672
+ <td class="default">
673
+
674
+ <code>[]</code>
675
+
676
+ </td>
677
+
678
+
679
+ <td class="description last">Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock'].</td>
680
+ </tr>
681
+
682
+
683
+ </tbody>
684
+ </table>
685
+
686
+ </td>
687
+ </tr>
688
+
689
+
690
+ </tbody>
691
+ </table>
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <h5 class="h5-returns">Returns:</h5>
709
+
710
+
711
+ <div class="param-desc">
712
+ - The lessons for the instructor or null if not found.
713
+ </div>
714
+
715
+
716
+
717
+ <dl class="param-type">
718
+ <dt>
719
+ Type
720
+ </dt>
721
+ <dd>
722
+
723
+ <span class="param-type">Promise.&lt;InstructorLessonsResponse></span>
724
+
725
+
726
+
727
+ </dd>
728
+ </dl>
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+ <h4 class="name" id="~fetchInstructors"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchInstructors<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;Instructor>>}</span></h4>
740
+
741
+
742
+
743
+
744
+
745
+
746
+ <dl class="details">
747
+
748
+ <dt class="tag-description">Description:</dt>
749
+ <dd class="tag-description"><ul class="dummy"><li>Fetch all instructor with lessons available for a specific brand.</li></ul></dd>
750
+
751
+
752
+
753
+ <dt class="tag-source">Source:</dt>
754
+ <dd class="tag-source"><ul class="dummy"><li>
755
+ <a href="content_instructor.ts.html">content/instructor.ts</a>, <a href="content_instructor.ts.html#line17">line 17</a>
756
+ </li></ul></dd>
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+
788
+ </dl>
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+ <h5 class="h5-examples">Example</h5>
801
+
802
+ <pre class="prettyprint"><code>fetchInstructors('drumeo')
803
+ .then(instructors => console.log(instructors))
804
+ .catch(error => console.error(error));</code></pre>
805
+
806
+
807
+
808
+
809
+ <h5 class="h5-parameters">Parameters:</h5>
810
+
811
+
812
+ <table class="params">
813
+ <thead>
814
+ <tr>
815
+
816
+ <th>Name</th>
817
+
818
+
819
+ <th>Type</th>
820
+
821
+
822
+
823
+
824
+
825
+ <th class="last">Description</th>
826
+ </tr>
827
+ </thead>
828
+
829
+ <tbody>
830
+
831
+
832
+ <tr>
833
+
834
+ <td class="name"><code>brand</code></td>
835
+
836
+
837
+ <td class="type">
838
+
839
+
840
+ <span class="param-type">string</span>
841
+
842
+
843
+
844
+
845
+ </td>
846
+
847
+
848
+
849
+
850
+
851
+ <td class="description last">The brand for which to fetch instructors.</td>
852
+ </tr>
853
+
854
+
855
+ </tbody>
856
+ </table>
857
+
858
+
859
+
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+
872
+
873
+ <h5 class="h5-returns">Returns:</h5>
874
+
875
+
876
+ <div class="param-desc">
877
+ - A promise that resolves to an array of instructor objects.
878
+ </div>
879
+
880
+
881
+
882
+ <dl class="param-type">
883
+ <dt>
884
+ Type
885
+ </dt>
886
+ <dd>
887
+
888
+ <span class="param-type">Promise.&lt;Array.&lt;Instructor>></span>
889
+
890
+
891
+
892
+ </dd>
893
+ </dl>
894
+
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+ </article>
906
+
907
+ </section>
908
+
909
+
910
+
911
+
912
+
913
+
914
+ </div>
915
+
916
+ <br class="clear">
917
+
918
+ <footer>
919
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Nov 19 2025 23:31:21 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
920
+ </footer>
921
+
922
+ <script>prettyPrint();</script>
923
+ <script src="scripts/polyfill.js"></script>
924
+ <script src="scripts/linenumber.js"></script>
925
+
926
+
927
+
928
+ </body>
929
+ </html>