@quenty/playerthumbnailutils 4.0.0-canary.236.5597d0a.0 → 4.1.0

package/CHANGELOG.md

@@ -3,7 +3,63 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.3.0...@quenty/playerthumbnailutils@4.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@4.0.0...@quenty/playerthumbnailutils@4.1.0) (2022-03-10)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.7.0...@quenty/playerthumbnailutils@4.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+# [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.6.1...@quenty/playerthumbnailutils@3.7.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+## [3.6.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.6.0...@quenty/playerthumbnailutils@3.6.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.5.0...@quenty/playerthumbnailutils@3.6.0) (2022-01-07)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.4.1...@quenty/playerthumbnailutils@3.5.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+## [3.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.4.0...@quenty/playerthumbnailutils@3.4.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/playerthumbnailutils
+
+
+
+
+
+# [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerthumbnailutils@3.3.0...@quenty/playerthumbnailutils@3.4.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/playerthumbnailutils
 

package/README.md

@@ -1,10 +1,10 @@
 ## PlayerThumbnailUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,13 +13,9 @@
 
 Reimplementation of Player:GetUserThumbnailAsync but as a promise with retry logic
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/PlayerThumbnailUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/playerthumbnailutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `PlayerThumbnailUtils.promiseUserThumbnail(userId, thumbnailType, thumbnailSize)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/playerthumbnailutils",
-  "version": "4.0.0-canary.236.5597d0a.0",
+  "version": "4.1.0",
   "description": "Reimplementation of Player:GetUserThumbnailAsync but as a promise with retry logic",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/promise": "4.0.0-canary.236.5597d0a.0"
+    "@quenty/loader": "^4.0.0",
+    "@quenty/promise": "^4.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "0797de955876b050fb24875de0423453e268b2ce"
 }

package/src/Shared/PlayerThumbnailUtils.lua

@@ -1,6 +1,9 @@
---- Reimplementation of Player:GetUserThumbnailAsync but as a promise with
---  retry logic
--- @module PlayerThumbnailUtils
+--[=[
+	Reimplementation of Player:GetUserThumbnailAsync but as a promise with
+	retry logic.
+
+	@class PlayerThumbnailUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -12,6 +15,19 @@ local MAX_TRIES = 5
 
 local PlayerThumbnailUtils = {}
 
+--[=[
+	Promises a user thumbnail with retry enabled.
+
+	```lua
+	PlayerThumbnailUtils.promiseUserThumbnail(4397833):Then(function(image)
+		imageLabel.Image = image
+	end)
+	```
+	@param userId number
+	@param thumbnailType ThumbnailType?
+	@param thumbnailSize ThumbnailSize?
+	@return Promise<string>
+]=]
 function PlayerThumbnailUtils.promiseUserThumbnail(userId, thumbnailType, thumbnailSize)
 	assert(type(userId) == "number", "Bad userId")
 	thumbnailType = thumbnailType or Enum.ThumbnailType.HeadShot
@@ -44,6 +60,11 @@ function PlayerThumbnailUtils.promiseUserThumbnail(userId, thumbnailType, thumbn
 	return promise
 end
 
+--[=[
+	Promises a player userName with retries enabled.
+	@param userId number
+	@return Promise<string>
+]=]
 function PlayerThumbnailUtils.promiseUserName(userId)
 	assert(type(userId) == "number", "Bad userId")