Skip to content

Commit 11ae689

Browse files
committed
docs: Update docs for AssetServiceCache
1 parent d09c339 commit 11ae689

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

src/assetserviceutils/src/Shared/AssetServiceCache.lua

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
--!strict
12
--[=[
3+
AssetServiceCache is a cache for the AssetServiceUtils functions.
4+
25
@class AssetServiceCache
36
]=]
47

@@ -7,18 +10,28 @@ local require = require(script.Parent.loader).load(script)
710
local MemorizeUtils = require("MemorizeUtils")
811
local AssetServiceUtils = require("AssetServiceUtils")
912
local _ServiceBag = require("ServiceBag")
13+
local _Promise = require("Promise")
1014

1115
local AssetServiceCache = {}
1216
AssetServiceCache.ServiceName = "AssetServiceCache"
1317

18+
--[=[
19+
Initializes the AssetServiceCache.
20+
@param serviceBag ServiceBag
21+
]=]
1422
function AssetServiceCache:Init(serviceBag: _ServiceBag.ServiceBag)
1523
assert(not self._serviceBag, "Already initialized")
1624
self._serviceBag = assert(serviceBag, "No serviceBag")
1725

1826
self:_ensureInit()
1927
end
2028

21-
function AssetServiceCache:PromiseBundleDetails(bundleId: number)
29+
--[=[
30+
Returns a promise that resolves to the bundle details for the given bundleId.
31+
@param bundleId number
32+
@return Promise<BundleDetails>
33+
]=]
34+
function AssetServiceCache:PromiseBundleDetails(bundleId: number): _Promise.Promise<AssetServiceUtils.BundleDetails>
2235
assert(type(bundleId) == "number", "Bad bundleId")
2336

2437
self:_ensureInit()

src/assetserviceutils/src/Shared/AssetServiceUtils.lua

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
--!strict
12
--[=[
23
Utility methods involving the AssetService
34
@class AssetServiceUtils
@@ -15,9 +16,9 @@ local AssetServiceUtils = {}
1516
Retrieves the assetIds for a package
1617
1718
@param packageAssetId number
18-
@return Promise<table>
19+
@return Promise<{ number }>
1920
]=]
20-
function AssetServiceUtils.promiseAssetIdsForPackage(packageAssetId: number)
21+
function AssetServiceUtils.promiseAssetIdsForPackage(packageAssetId: number): Promise.Promise<{ number }>
2122
assert(type(packageAssetId) == "number", "Bad packageAssetId")
2223

2324
return Promise.spawn(function(resolve, reject)
@@ -43,7 +44,7 @@ end
4344
4445
@return Promise<Pages>
4546
]=]
46-
function AssetServiceUtils.promiseGamePlaces()
47+
function AssetServiceUtils.promiseGamePlaces(): Promise.Promise<Pages>
4748
return Promise.spawn(function(resolve, reject)
4849
local pages
4950
local ok, err = pcall(function()
@@ -102,7 +103,7 @@ export type BundleDetails = {
102103
@param bundleId number
103104
@return Promise<BundleDetails>
104105
]=]
105-
function AssetServiceUtils.promiseBundleDetails(bundleId: number)
106+
function AssetServiceUtils.promiseBundleDetails(bundleId: number): Promise.Promise<BundleDetails>
106107
assert(type(bundleId) == "number", "Bad bundleId")
107108

108109
return Promise.spawn(function(resolve, reject)

0 commit comments

Comments
 (0)