@quenty/badgeutils 3.3.0 → 3.3.1-canary.238.2c4d310.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.3.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.3.0...@quenty/badgeutils@3.3.1-canary.238.2c4d310.0) (2021-12-29)
7
+
8
+ **Note:** Version bump only for package @quenty/badgeutils
9
+
10
+
11
+
12
+
13
+
6
14
  # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.2.0...@quenty/badgeutils@3.3.0) (2021-12-18)
7
15
 
8
16
  **Note:** Version bump only for package @quenty/badgeutils
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## BadgeUtils
2
2
  <div align="center">
3
- <a href="http://quenty.github.io/api/">
3
+ <a href="http://quenty.github.io/NevermoreEngine/">
4
4
  <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
5
5
  </a>
6
6
  <a href="https://discord.gg/mhtGUS8">
7
- <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
7
+ <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
8
8
  </a>
9
9
  <a href="https://github.com/Quenty/NevermoreEngine/actions">
10
10
  <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/badgeutils",
3
- "version": "3.3.0",
3
+ "version": "3.3.1-canary.238.2c4d310.0",
4
4
  "description": "Utility functions involving badges on Roblox",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -25,11 +25,11 @@
25
25
  "Quenty"
26
26
  ],
27
27
  "dependencies": {
28
- "@quenty/loader": "^3.1.1",
29
- "@quenty/promise": "^3.3.0"
28
+ "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
29
+ "@quenty/promise": "3.3.1-canary.238.2c4d310.0"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"
33
33
  },
34
- "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
34
+ "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
35
35
  }
@@ -1,6 +1,7 @@
1
- --- Utility functions involving badges on Roblox
2
- -- @module BadgeUtils
3
- -- @author Quenty
1
+ --[=[
2
+ Utility functions involving badges on Roblox
3
+ @class BadgeUtils
4
+ ]=]
4
5
 
5
6
  local BadgeService = game:GetService("BadgeService")
6
7
 
@@ -10,6 +11,13 @@ local Promise = require("Promise")
10
11
 
11
12
  local BadgeUtils = {}
12
13
 
14
+ --[=[
15
+ Tries to reward a player to a badge inside of a promise.
16
+
17
+ @param player Player
18
+ @param badgeId number
19
+ @return Promise
20
+ ]=]
13
21
  function BadgeUtils.promiseAwardBadge(player, badgeId)
14
22
  assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
15
23
  assert(type(badgeId) == "number", "Bad badgeId")