@quenty/insertserviceutils 3.2.1-canary.8533eea.0 → 3.3.1

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,7 +3,15 @@
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.2.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/insertserviceutils@3.2.0...@quenty/insertserviceutils@3.2.1-canary.8533eea.0) (2021-12-18)
6
+ ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/insertserviceutils@3.3.0...@quenty/insertserviceutils@3.3.1) (2021-12-30)
7
+
8
+ **Note:** Version bump only for package @quenty/insertserviceutils
9
+
10
+
11
+
12
+
13
+
14
+ # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/insertserviceutils@3.2.0...@quenty/insertserviceutils@3.3.0) (2021-12-18)
7
15
 
8
16
  **Note:** Version bump only for package @quenty/insertserviceutils
9
17
 
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## InsertServiceUtils
2
2
  <div align="center">
3
- <a href="http://quenty.github.io/api/">
4
- <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
3
+ <a href="http://quenty.github.io/NevermoreEngine/">
4
+ <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
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" />
@@ -14,12 +14,9 @@ Utility functions to make inserting things from insert service easier. Especiall
14
14
 
15
15
  Note this only works from the server.
16
16
 
17
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/InsertServiceUtils">View docs →</a></div>
18
+
17
19
  ## Installation
18
20
  ```
19
21
  npm install @quenty/insertserviceutils --save
20
- ```
21
-
22
- ## Usage
23
-
24
- ### `function InsertServiceUtils.promiseAsset(assetId)`
25
- Promises the resulting asset is inserted from insert service, or a rejection
22
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/insertserviceutils",
3
- "version": "3.2.1-canary.8533eea.0",
3
+ "version": "3.3.1",
4
4
  "description": "InsertServiceUtils to make loading models via insert service easy",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -24,11 +24,11 @@
24
24
  "Quenty"
25
25
  ],
26
26
  "dependencies": {
27
- "@quenty/loader": "3.1.1",
28
- "@quenty/promise": "3.2.1-canary.8533eea.0"
27
+ "@quenty/loader": "^3.1.2",
28
+ "@quenty/promise": "^3.3.1"
29
29
  },
30
30
  "publishConfig": {
31
31
  "access": "public"
32
32
  },
33
- "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
33
+ "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
34
34
  }
@@ -1,6 +1,6 @@
1
- ---
2
- -- @module InsertServiceUtils
3
- -- @author Quenty
1
+ --[=[
2
+ @class InsertServiceUtils
3
+ ]=]
4
4
 
5
5
  local require = require(script.Parent.loader).load(script)
6
6
 
@@ -10,7 +10,12 @@ local Promise = require("Promise")
10
10
 
11
11
  local InsertServiceUtils = {}
12
12
 
13
- --- Promises the resulting asset is inserted from insert service, or a rejection
13
+ --[=[
14
+ Promises the resulting asset is inserted from insert service, or a rejection
15
+
16
+ @param assetId number
17
+ @return Promise<Instance>
18
+ ]=]
14
19
  function InsertServiceUtils.promiseAsset(assetId)
15
20
  assert(type(assetId) == "number", "Bad assetId")
16
21