Stop referencing returnPromises in @return doc (#182)

tumblr · Aug 18, 2023 · bf870c8 · bf870c8
1 parent 68deae9
commit bf870c8
Showing 1 changed file with 23 additions and 23 deletions.
diff --git a/lib/tumblr.js b/lib/tumblr.js
@@ -194,7 +194,7 @@ class TumblrClient {
    * @param  {Record<string,any>|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   getRequest(apiPath, paramsOrCallback, callback) {
     let params = paramsOrCallback;
@@ -489,7 +489,7 @@ class TumblrClient {
    * @param  {import('./types').NpfReblogParams | import('./types').NpfPostParams } params
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   createPost(blogIdentifier, params, callback) {
     const data = this.#transformNpfParams(params);
@@ -506,7 +506,7 @@ class TumblrClient {
    * @param  {import('./types').NpfReblogParams | import('./types').NpfPostParams } params
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   editPost(blogIdentifier, postId, params, callback) {
     const data = this.#transformNpfParams(params);
@@ -536,7 +536,7 @@ class TumblrClient {
    * @param  {Record<string,any>} params
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   createLegacyPost(blogIdentifier, params, callback) {
     return this.postRequest(`/v2/blog/${blogIdentifier}/post`, params, callback);
@@ -551,7 +551,7 @@ class TumblrClient {
    * @param  {Record<string,any>} params
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   editLegacyPost(blogIdentifier, params, callback) {
     return this.postRequest(`/v2/blog/${blogIdentifier}/post/edit`, params, callback);
@@ -564,7 +564,7 @@ class TumblrClient {
    * @param  {string} reblogKey - Reblog key of post to like
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   likePost(postId, reblogKey, callback) {
     return this.postRequest('/v2/user/like', { id: postId, reblog_key: reblogKey }, callback);
@@ -577,7 +577,7 @@ class TumblrClient {
    * @param  {string} reblogKey - Reblog key of post to like
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   unlikePost(postId, reblogKey, callback) {
     return this.postRequest('/v2/user/unlike', { id: postId, reblog_key: reblogKey }, callback);
@@ -589,7 +589,7 @@ class TumblrClient {
    * @param  {{url: string}|{email:string}} params - parameters sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   followBlog(params, callback) {
     return this.postRequest('/v2/user/follow', params, callback);
@@ -601,7 +601,7 @@ class TumblrClient {
    * @param  {{url: string}} params - parameters sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   unfollowBlog(params, callback) {
     return this.postRequest('/v2/user/unfollow', params, callback);
@@ -614,7 +614,7 @@ class TumblrClient {
    * @param  {string} postId - Post ID to delete
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   deletePost(blogIdentifier, postId, callback) {
     return this.postRequest(`/v2/blog/${blogIdentifier}/post/delete`, { id: postId }, callback);
@@ -629,7 +629,7 @@ class TumblrClient {
    * @param  {Record<string,any>} params - parameters sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   reblogPost(blogIdentifier, params, callback) {
     return this.postRequest(`/v2/blog/${blogIdentifier}/post/reblog`, params, callback);
@@ -642,7 +642,7 @@ class TumblrClient {
    * @param  {{'fields[blogs]'?: string}|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogInfo(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(`/v2/blog/${blogIdentifier}/info`, paramsOrCallback, callback);
@@ -655,7 +655,7 @@ class TumblrClient {
    * @param  {{limit?: number; offset?: number; before?: number; after?: number}|TumblrClientCallback} [paramsOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogLikes(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(`/v2/blog/${blogIdentifier}/likes`, paramsOrCallback, callback);
@@ -668,7 +668,7 @@ class TumblrClient {
    * @param  {{limit?: number; offset?: number}|TumblrClientCallback} [paramsOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogFollowers(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(`/v2/blog/${blogIdentifier}/followers`, paramsOrCallback, callback);
@@ -692,7 +692,7 @@ class TumblrClient {
    * @param  {{limit?: number; offset?: number; filter?: 'text'|'raw'}|TumblrClientCallback} [paramsOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogQueue(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(`/v2/blog/${blogIdentifier}/posts/queue`, paramsOrCallback, callback);
@@ -705,7 +705,7 @@ class TumblrClient {
    * @param  {{before_id?: number; filter?: PostFormatFilter}|TumblrClientCallback} [paramsOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogDrafts(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(`/v2/blog/${blogIdentifier}/posts/draft`, paramsOrCallback, callback);
@@ -718,7 +718,7 @@ class TumblrClient {
    * @param  {{offset?: number; filter?: PostFormatFilter}|TumblrClientCallback} [paramsOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogSubmissions(blogIdentifier, paramsOrCallback, callback) {
     return this.getRequest(
@@ -735,7 +735,7 @@ class TumblrClient {
    * @param  {16|24|30|40|48|64|96|128|512|TumblrClientCallback} [sizeOrCallback] - optional data sent with the request
    * @param  {TumblrClientCallback} [maybeCallback] - invoked when the request completes
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   blogAvatar(blogIdentifier, sizeOrCallback, maybeCallback) {
     const size = typeof sizeOrCallback === 'function' ? undefined : sizeOrCallback;
@@ -752,7 +752,7 @@ class TumblrClient {
    *
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   userInfo(callback) {
     return this.getRequest('/v2/user/info', undefined, callback);
@@ -764,7 +764,7 @@ class TumblrClient {
    * @param  {Record<string,any>|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   userDashboard(paramsOrCallback, callback) {
     return this.getRequest('/v2/user/dashboard', paramsOrCallback, callback);
@@ -776,7 +776,7 @@ class TumblrClient {
    * @param  {{limit?: number; offset?: number;}|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   userFollowing(paramsOrCallback, callback) {
     return this.getRequest('/v2/user/following', paramsOrCallback, callback);
@@ -788,7 +788,7 @@ class TumblrClient {
    * @param  {{limit?: number; offset?: number; before?: number; after?: number}|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   userLikes(paramsOrCallback, callback) {
     return this.getRequest('/v2/user/likes', paramsOrCallback, callback);
@@ -801,7 +801,7 @@ class TumblrClient {
    * @param  {Record<string,any>|TumblrClientCallback} [paramsOrCallback] - query parameters
    * @param  {TumblrClientCallback} [callback] **Deprecated** Omit the callback and use the promise form
    *
-   * @return {Promise<any>|undefined} Request object, or Promise if {@link returnPromises} was used
+   * @return {Promise<any>|undefined} Promise if no callback is provided
    */
   taggedPosts(tag, paramsOrCallback, callback) {
     const params = { tag };