@quenty/contentproviderutils 3.3.0 → 3.4.0-canary.241.a4e8214.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,22 @@
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.4.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/contentproviderutils@3.3.1...@quenty/contentproviderutils@3.4.0-canary.241.a4e8214.0) (2022-01-03)
7
+
8
+ **Note:** Version bump only for package @quenty/contentproviderutils
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/contentproviderutils@3.3.0...@quenty/contentproviderutils@3.3.1) (2021-12-30)
15
+
16
+ **Note:** Version bump only for package @quenty/contentproviderutils
17
+
18
+
19
+
20
+
21
+
6
22
  # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/contentproviderutils@3.2.0...@quenty/contentproviderutils@3.3.0) (2021-12-18)
7
23
 
8
24
  **Note:** Version bump only for package @quenty/contentproviderutils
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## ContentProviderUtils
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" />
@@ -13,6 +13,8 @@
13
13
 
14
14
  Utility functions to ensure that content is preloaded (wrapping calls in promises)
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ContentProviderUtils">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/contentproviderutils --save
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/contentproviderutils",
3
- "version": "3.3.0",
3
+ "version": "3.4.0-canary.241.a4e8214.0",
4
4
  "description": "Utility functions to ensure that content is preloaded (wrapping calls in promises)",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -27,11 +27,11 @@
27
27
  "Quenty"
28
28
  ],
29
29
  "dependencies": {
30
- "@quenty/loader": "^3.1.1",
31
- "@quenty/promise": "^3.3.0"
30
+ "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
31
+ "@quenty/promise": "3.4.0-canary.241.a4e8214.0"
32
32
  },
33
33
  "publishConfig": {
34
34
  "access": "public"
35
35
  },
36
- "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
36
+ "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
37
37
  }
@@ -1,5 +1,7 @@
1
- --- Utility functions to ensure that content is preloaded (wrapping calls in promises)
2
- -- @module ContentProviderUtils
1
+ --[=[
2
+ Utility functions to ensure that content is preloaded (wrapping calls in promises)
3
+ @class ContentProviderUtils
4
+ ]=]
3
5
 
4
6
  local require = require(script.Parent.loader).load(script)
5
7
 
@@ -9,7 +11,15 @@ local Promise = require("Promise")
9
11
 
10
12
  local ContentProviderUtils = {}
11
13
 
12
- -- Note: If strings are passed in, it only preloads textures, and will preload meshes, but only to http client.
14
+ --[=[
15
+ Preloads assets
16
+ :::note
17
+ If strings are passed in, it only preloads textures, and will preload meshes, but only to http client.
18
+ :::
19
+
20
+ @param contentIdList { Instance | string }
21
+ @return Promise
22
+ ]=]
13
23
  function ContentProviderUtils.promisePreload(contentIdList)
14
24
  assert(type(contentIdList) == "table", "Bad contentIdList")
15
25