{"id":"stevendahfish/typed-promise","name":"typed-promise","scope":"stevendahfish","platform":"roblox","description":"Promises with types & comments","version":"4.0.2","latest":"4.0.2","versions":["4.0.2"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"evaera/promise":{"version":"^4.0.0","alias":"Promise"}},"integrity":"a3d4d718f54105a7dee7c91fea2876a7514e68d953d9f956a98e4945c98d9267","likes":0,"downloads":0,"install":"forest install stevendahfish/typed-promise","url":"https://forest.dev/p/roblox/stevendahfish/typed-promise","files":"https://api.forest.dev/ai/package/roblox/stevendahfish/typed-promise/files","readme":"# RbxTypedPromise\r\n\r\nThis package wraps around [roblox-lua-promise](https://github.com/evaera/roblox-lua-promise) and\r\nadds types.\r\n\r\n## Installation\r\n\r\nYou can install this package on Wally.\r\n\r\n```toml\r\n[dependencies]\r\nPromise = \"stevendahfish/typed-promise@4.0.2\"\r\n```\r\n\r\n### wally-package-types\r\n\r\nTo use the types provided by the package, you must use the [wally-package-types](https://github.com/JohnnyMorganz/wally-package-types)\r\ntool after running `wally install`. You can install it using [Aftman](https://github.com/LPGHatGuy/aftman).\r\n\r\n## Types\r\n\r\nDue to certain limitations ([which might be loosened in the future](https://github.com/Roblox/luau/pull/86))\r\nthis package cannot provide full typings. Therefore, there are two types: `TypedPromise<T...>` and `Promise`.\r\n\r\nAny method of Promise that returns a Promise, such as `:andThen` or `:catch` will return the `Promise` type\r\nbecause of Luau limitations.\r\n\r\nThe constructors, like `Promise.new` or `Promise.try` are strictly typed and return a `TypedPromise<T...>`.\r\n\r\nMake sure you run [wally-package-types](#wally-package-types) in order to access the types!\r\n\r\n## Fork\r\nThis fork adds comments that originally existed in the Promises library to the type definitions.","readmeTruncated":false}