@quenty/rx 13.17.0 → 13.17.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [13.17.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@13.17.0...@quenty/rx@13.17.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [13.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rx@13.16.2...@quenty/rx@13.17.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/rx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rx",
-  "version": "13.17.0",
+  "version": "13.17.1",
   "description": "Quenty's reactive library for Roblox",
   "keywords": [
     "Roblox",
@@ -27,19 +27,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/cancellabledelay": "^3.5.0",
-    "@quenty/canceltoken": "^11.11.1",
-    "@quenty/ducktype": "^5.8.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/symbol": "^3.4.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/throttle": "^10.9.0"
+    "@quenty/cancellabledelay": "^3.5.1",
+    "@quenty/canceltoken": "^11.11.2",
+    "@quenty/ducktype": "^5.8.2",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/symbol": "^3.4.1",
+    "@quenty/table": "^3.7.2",
+    "@quenty/throttle": "^10.9.1",
+    "@quenty/typeutils": "^1.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Observable.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Observables are like an [signal](/api/Signal), except they do not execute code
 	until the observable is subscribed to. This follows the standard
@@ -59,6 +60,7 @@ local require = require(script.Parent.loader).load(script)
 
 local Subscription = require("Subscription")
 local DuckTypeUtils = require("DuckTypeUtils")
+local _MaidTaskUtils = require("MaidTaskUtils")
 
 local ENABLE_STACK_TRACING = false
 
@@ -66,12 +68,24 @@ local Observable = {}
 Observable.ClassName = "Observable"
 Observable.__index = Observable
 
+export type OnSubscribe<T...> = (subscription: Subscription.Subscription<T...>) -> _MaidTaskUtils.MaidTask?
+
+export type Transformer<T..., U...> = (observable: Observable<T...>) -> Observable<U...>
+
+export type Observable<T...> = typeof(setmetatable(
+	{} :: {
+		_source: string?,
+		_onSubscribe: OnSubscribe<T...>,
+	},
+	Observable
+))
+
 --[=[
 	Returns whether or not a value is an observable.
 	@param item any
 	@return boolean
 ]=]
-function Observable.isObservable(item)
+function Observable.isObservable(item: any): boolean
 	return DuckTypeUtils.isImplementation(Observable, item)
 end
 
@@ -83,7 +97,7 @@ end
 		return Observable.new(function(sub)
 			local maid = Maid.new()
 
-			for _, item in pairs(parent:GetChildren()) do
+			for _, item in parent:GetChildren() do
 				sub:Fire(item)
 			end
 			maid:GiveTask(parent.ChildAdded:Connect(function(child)
@@ -103,12 +117,12 @@ end
 	@param onSubscribe (subscription: Subscription<T>) -> MaidTask
 	@return Observable<T>
 ]=]
-function Observable.new(onSubscribe)
+function Observable.new<T...>(onSubscribe: OnSubscribe<T...>): Observable<T...>
 	assert(type(onSubscribe) == "function", "Bad onSubscribe")
 
 	return setmetatable({
-		_source = if ENABLE_STACK_TRACING then debug.traceback("Observable.new()", 2) else nil;
-		_onSubscribe = onSubscribe;
+		_source = if ENABLE_STACK_TRACING then debug.traceback("Observable.new()", 2) else nil,
+		_onSubscribe = onSubscribe,
 	}, Observable)
 end
 
@@ -132,11 +146,11 @@ end
 	@param transformers { (observable: Observable<T>) -> Observable<T> }
 	@return Observable<T>
 ]=]
-function Observable:Pipe(transformers)
+function Observable.Pipe<T...>(self: Observable<T...>, transformers: { Transformer<T..., ...any> }): Observable<...any>
 	assert(type(transformers) == "table", "Bad transformers")
 
-	local current = self
-	for _, transformer in pairs(transformers) do
+	local current: any = self
+	for _, transformer in transformers do
 		assert(type(transformer) == "function", "Bad transformer")
 		current = transformer(current)
 		assert(Observable.isObservable(current), "Transformer must return an observable")
@@ -154,12 +168,17 @@ end
 	@param completeCallback function?
 	@return MaidTask
 ]=]
-function Observable:Subscribe(fireCallback, failCallback, completeCallback)
+function Observable.Subscribe<T...>(
+	self: Observable<T...>,
+	fireCallback: Subscription.FireCallback<T...>?,
+	failCallback: Subscription.FailCallback?,
+	completeCallback: Subscription.CompleteCallback?
+): Subscription.Subscription<T...>
 	local sub = Subscription.new(fireCallback, failCallback, completeCallback, self._source)
 
 	sub:_assignCleanup(self._onSubscribe(sub))
 
-	return sub
+	return sub :: any
 end
 
-return Observable
+return Observable

package/src/Shared/ObservableSubscriptionTable.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	This allows the storage of subscriptions for keys, such that something
 	can subscribe onto a key, and events can be invoked onto keys.
@@ -7,13 +8,21 @@
 local require = require(script.Parent.loader).load(script)
 
 local Observable = require("Observable")
+local _Subscription = require("Subscription")
 
 local ObservableSubscriptionTable = {}
 ObservableSubscriptionTable.ClassName = "ObservableSubscriptionTable"
 ObservableSubscriptionTable.__index = ObservableSubscriptionTable
 
-function ObservableSubscriptionTable.new()
-	local self = setmetatable({}, ObservableSubscriptionTable)
+export type ObservableSubscriptionTable<T...> = typeof(setmetatable(
+	{} :: {
+		_subMap: { [any]: { _Subscription.Subscription<T...> } },
+	},
+	ObservableSubscriptionTable
+))
+
+function ObservableSubscriptionTable.new<T...>(): ObservableSubscriptionTable<T...>
+	local self = setmetatable({} :: any, ObservableSubscriptionTable)
 
 	self._subMap = {} -- { TKey: Subscription<TEmit> }
 
@@ -25,7 +34,7 @@ end
 	@param key TKey
 	@param ... TEmit
 ]=]
-function ObservableSubscriptionTable:Fire(key, ...)
+function ObservableSubscriptionTable.Fire<T...>(self: ObservableSubscriptionTable<T...>, key: any, ...)
 	assert(key ~= nil, "Bad key")
 
 	local subs = self._subMap[key]
@@ -34,7 +43,7 @@ function ObservableSubscriptionTable:Fire(key, ...)
 	end
 
 	-- Make a copy so we don't have to worry about our last changing
-	for _, sub in pairs(table.clone(subs)) do
+	for _, sub: any in table.clone(subs) do
 		if sub:IsPending() then
 			-- TODO: Use connection here
 			task.spawn(sub.Fire, sub, ...)
@@ -48,7 +57,7 @@ end
 	@param key TKey
 	@return boolean
 ]=]
-function ObservableSubscriptionTable:HasSubscriptions(key)
+function ObservableSubscriptionTable.HasSubscriptions<T...>(self: ObservableSubscriptionTable<T...>, key: any): boolean
 	return self._subMap[key] ~= nil
 end
 
@@ -57,7 +66,7 @@ end
 
 	@param key TKey
 ]=]
-function ObservableSubscriptionTable:Complete(key)
+function ObservableSubscriptionTable.Complete<T...>(self: ObservableSubscriptionTable<T...>, key: any)
 	local subs = self._subMap[key]
 	if not subs then
 		return
@@ -66,7 +75,7 @@ function ObservableSubscriptionTable:Complete(key)
 	local subsToComplete = table.clone(subs)
 	self._subMap[key] = nil
 
-	for _, sub in pairs(subsToComplete) do
+	for _, sub: any in subsToComplete do
 		if sub:IsPending() then
 			task.spawn(sub.Complete, sub)
 		end
@@ -78,7 +87,7 @@ end
 
 	@param key TKey
 ]=]
-function ObservableSubscriptionTable:Fail(key)
+function ObservableSubscriptionTable.Fail<T...>(self: ObservableSubscriptionTable<T...>, key: any)
 	local subs = self._subMap[key]
 	if not subs then
 		return
@@ -87,20 +96,26 @@ function ObservableSubscriptionTable:Fail(key)
 	local subsToFail = table.clone(subs)
 	self._subMap[key] = nil
 
-	for _, sub in pairs(subsToFail) do
+	for _, sub: any in subsToFail do
 		if sub:IsPending() then
 			task.spawn(sub.Fail, sub)
 		end
 	end
 end
 
+export type RetrieveInitialValue<T...> = (sub: _Subscription.Subscription<T...>) -> ()
+
 --[=[
 	Observes for the key
 	@param key TKey
 	@param retrieveInitialValue callback -- Optional
 	@return Observable<TEmit>
 ]=]
-function ObservableSubscriptionTable:Observe(key, retrieveInitialValue)
+function ObservableSubscriptionTable.Observe<T...>(
+	self: ObservableSubscriptionTable<T...>,
+	key: any,
+	retrieveInitialValue: RetrieveInitialValue<T...>?
+): Observable.Observable<T...>
 	assert(key ~= nil, "Bad key")
 
 	return Observable.new(function(sub)
@@ -142,12 +157,14 @@ end
 --[=[
 	Completes all subscriptions and removes them from the list.
 ]=]
-function ObservableSubscriptionTable:Destroy()
+function ObservableSubscriptionTable.Destroy<T...>(self: ObservableSubscriptionTable<T...>)
 	while next(self._subMap) do
 		local key, list = next(self._subMap)
+		assert(key, "Key should not be nil")
+
 		self._subMap[key] = nil
 
-		for _, sub in pairs(list) do
+		for _, sub: any in list do
 			if sub:IsPending() then
 				task.spawn(sub.Complete, sub)
 			end

package/src/Shared/Rx.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Observable rx library for Roblox by Quenty. This provides a variety of
 	composition classes to be used, and is the primary entry point for an
@@ -12,14 +13,20 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local CancelToken = require("CancelToken")
 local Maid = require("Maid")
+local MaidTaskUtils = require("MaidTaskUtils")
 local Observable = require("Observable")
 local Promise = require("Promise")
 local Symbol = require("Symbol")
 local ThrottledFunction = require("ThrottledFunction")
+local _Subscription = require("Subscription")
 local cancellableDelay = require("cancellableDelay")
-local CancelToken = require("CancelToken")
-local MaidTaskUtils = require("MaidTaskUtils")
+local _Signal = require("Signal")
+
+export type Map<Key, Value> = { [Key]: Value }
+export type Set<T> = { [T]: true }
+export type Predicate<T...> = (T...) -> boolean
 
 local UNSET_VALUE = Symbol.named("unsetValue")
 local function identity(...)
@@ -42,8 +49,11 @@ end
 local Rx = {
 	EMPTY = Observable.new(function(sub)
 		sub:Complete()
+		return
+	end),
+	NEVER = Observable.new(function(_)
+		return
 	end),
-	NEVER = Observable.new(function(_) end),
 }
 
 --[=[
@@ -55,7 +65,7 @@ local Rx = {
 ]=]
 function Rx.pipe(transformers)
 	assert(type(transformers) == "table", "Bad transformers")
-	for index, transformer in pairs(transformers) do
+	for index, transformer in transformers do
 		if type(transformer) ~= "function" then
 			error(
 				string.format(
@@ -71,7 +81,7 @@ function Rx.pipe(transformers)
 		assert(source, "Bad source")
 
 		local current = source
-		for key, transformer in pairs(transformers) do
+		for key, transformer in transformers do
 			current = transformer(current)
 
 			if not (type(current) == "table" and current.ClassName == "Observable") then
@@ -102,7 +112,7 @@ end
 	@param ... any -- Arguments to emit
 	@return Observable
 ]=]
-function Rx.of(...)
+function Rx.of<T...>(...: T...): Observable.Observable<T...>
 	local args = table.pack(...)
 
 	return Observable.new(function(sub)
@@ -111,6 +121,7 @@ function Rx.of(...)
 		end
 
 		sub:Complete()
+		return
 	end)
 end
 
@@ -125,6 +136,7 @@ function Rx.failed(...)
 
 	return Observable.new(function(sub)
 		sub:Fail(table.unpack(args, 1, args.n))
+		return
 	end)
 end
 
@@ -194,11 +206,11 @@ end
 	@param observables { Observable }
 	@return Observable
 ]=]
-function Rx.merge(observables)
+function Rx.merge<T...>(observables: { Observable.Observable<T...> }): Observable.Observable<T...>
 	assert(type(observables) == "table", "Bad observables")
 
 	local totalCount = 0
-	for _, item in pairs(observables) do
+	for _, item in observables do
 		assert(Observable.isObservable(item), "Not an observable")
 		totalCount = totalCount + 1
 	end
@@ -207,7 +219,7 @@ function Rx.merge(observables)
 		local maid = Maid.new()
 		local pendingCount = totalCount
 
-		for _, observable in pairs(observables) do
+		for _, observable: any in observables do
 			maid:GiveTask(observable:Subscribe(function(...)
 				sub:Fire(...)
 			end, function(...)
@@ -233,10 +245,10 @@ end
 	@param event Signal<T>
 	@return Observable<T>
 ]=]
-function Rx.fromSignal(event)
+function Rx.fromSignal<T...>(event: _Signal.Signal<T...> | RBXScriptSignal): Observable.Observable<T...>
 	return Observable.new(function(sub)
 		-- This stream never completes or fails!
-		return event:Connect(function(...)
+		return (event :: any):Connect(function(...)
 			sub:Fire(...)
 		end)
 	end)
@@ -249,7 +261,7 @@ end
 	@param promise Promise<T>
 	@return Observable<T>
 ]=]
-function Rx.fromPromise(promise)
+function Rx.fromPromise<T...>(promise: Promise.Promise<T...>): Observable.Observable<T...>
 	assert(Promise.isPromise(promise), "Bad promise")
 
 	return Observable.new(function(sub)
@@ -328,7 +340,7 @@ end
 	@param callback function
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.start(callback)
+function Rx.start<T...>(callback: () -> T...): Observable.Transformer<T..., T...>
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
@@ -348,10 +360,10 @@ end
 
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.share()
-	return function(source)
+function Rx.share<T...>(): Observable.Transformer<T..., T...>
+	return function(source): Observable.Observable<T...>
 		local shareMaid = Maid.new()
-		local subs = {}
+		local subs: { _Subscription.Subscription<T...> } = {}
 
 		local lastFail = UNSET_VALUE
 		local lastComplete = UNSET_VALUE
@@ -362,17 +374,17 @@ function Rx.share()
 				lastComplete = UNSET_VALUE
 
 				shareMaid._currentSub = source:Subscribe(function(...)
-					for _, sub in pairs(subs) do
+					for _, sub: any in subs do
 						sub:Fire(...)
 					end
 				end, function(...)
 					lastFail = table.pack(...)
-					for _, sub in pairs(subs) do
+					for _, sub: any in subs do
 						sub:Fail(...)
 					end
 				end, function(...)
 					lastComplete = table.pack(...)
-					for _, sub in pairs(subs) do
+					for _, sub: any in subs do
 						sub:Complete(...)
 					end
 				end)
@@ -412,7 +424,7 @@ function Rx.share()
 					end
 				end
 			end
-		end)
+		end) :: any
 	end
 end
 
@@ -423,27 +435,32 @@ end
 	@param windowTimeSeconds number? -- Time
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
+function Rx.shareReplay<T...>(bufferSize: number?, windowTimeSeconds: number?): Observable.Transformer<T..., T...>
 	assert(type(bufferSize) == "number" or bufferSize == nil, "Bad bufferSize")
 	assert(type(windowTimeSeconds) == "number" or windowTimeSeconds == nil, "Bad windowTimeSeconds")
 
-	bufferSize = bufferSize or math.huge
-	windowTimeSeconds = windowTimeSeconds or math.huge
+	local maxBufferSize = bufferSize or math.huge
+	local windowTime = windowTimeSeconds or math.huge
 
 	return function(source)
 		local shareMaid = Maid.new()
-		local subs = {}
+		local subs: { _Subscription.Subscription<T...> } = {}
 
-		local buffer = {}
+		type Event = {
+			n: number,
+			timestamp: number,
+		}
+
+		local buffer: { Event } = {}
 		local lastFail = UNSET_VALUE
 		local lastComplete = UNSET_VALUE
 
-		local function getEventsCopy()
+		local function getEventsCopy(): { Event }
 			local now = os.clock()
 			local events = {}
 
-			for _, event in pairs(buffer) do
-				if (now - event.timestamp) <= windowTimeSeconds then
+			for _, event in buffer do
+				if (now - event.timestamp) <= windowTime then
 					table.insert(events, event)
 				end
 			end
@@ -460,17 +477,17 @@ function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
 				shareMaid._currentSub = source:Subscribe(function(...)
 					-- TODO: also prune events by timestamp
 
-					if #buffer + 1 > bufferSize then
+					if #buffer + 1 > maxBufferSize then
 						table.remove(buffer, 1) -- O(n), not great.
 					end
 
 					-- Queue before we start
-					local event = table.pack(...)
+					local event: any = table.pack(...)
 					event.timestamp = os.clock()
 					table.insert(buffer, event)
 
 					-- Copy subs so removal doesn't affect replay
-					for _, sub in pairs(table.clone(subs)) do
+					for _, sub: any in table.clone(subs) do
 						if sub:IsPending() then
 							sub:Fire(table.unpack(event, 1, event.n))
 						end
@@ -479,7 +496,7 @@ function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
 					lastFail = table.pack(...)
 
 					-- Copy subs so removal doesn't affect replay
-					for _, sub in pairs(table.clone(subs)) do
+					for _, sub: any in table.clone(subs) do
 						if sub:IsPending() then
 							sub:Fail(...)
 						end
@@ -488,7 +505,7 @@ function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
 					lastComplete = table.pack(...)
 
 					-- Copy subs so removal doesn't affect replay
-					for _, sub in pairs(table.clone(subs)) do
+					for _, sub: any in table.clone(subs) do
 						if sub:IsPending() then
 							sub:Complete(...)
 						end
@@ -521,7 +538,7 @@ function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
 			table.insert(subs, sub)
 
 			-- Firing could lead to re-entrance. Lets just use the buffer as-is.
-			for _, item in pairs(getEventsCopy()) do
+			for _, item in getEventsCopy() do
 				sub:Fire(table.unpack(item, 1, item.n))
 			end
 
@@ -537,7 +554,7 @@ function Rx.shareReplay(bufferSize: number?, windowTimeSeconds: number?)
 					end
 				end
 			end
-		end)
+		end) :: Observable.Observable<T...>
 	end
 end
 
@@ -546,7 +563,7 @@ end
 
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.cache()
+function Rx.cache<T...>(): Observable.Transformer<T..., T...>
 	return Rx.shareReplay(1)
 end
 
@@ -556,19 +573,19 @@ end
 	@param callback () -> { T }
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.startFrom(callback)
+function Rx.startFrom<T, U>(callback: () -> { U }): Observable.Transformer<(T), (U | T)>
 	assert(type(callback) == "function", "Bad callback")
 
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
 		return Observable.new(function(sub)
-			for _, value in pairs(callback()) do
+			for _, value in callback() do
 				sub:Fire(value)
 			end
 
 			return source:Subscribe(sub:GetFireFailComplete())
-		end)
+		end) :: any
 	end
 end
 
@@ -579,19 +596,19 @@ end
 	@param values { T }
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.startWith(values)
+function Rx.startWith<T, U>(values: { U }): Observable.Transformer<(T), (T | U)>
 	assert(type(values) == "table", "Bad values")
 
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
 		return Observable.new(function(sub)
-			for _, item in pairs(values) do
+			for _, item in values do
 				sub:Fire(item)
 			end
 
 			return source:Subscribe(sub:GetFireFailComplete())
-		end)
+		end) :: any
 	end
 end
 
@@ -604,24 +621,24 @@ end
 
 	https://reactivex.io/documentation/operators/scan.html
 
-	@param accumulator function
-	@param seed any | nil
+	@param accumulator (T, U...) -> T
+	@param seed T?
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.scan(accumulator, seed)
+function Rx.scan<T, U...>(accumulator: (T?, U...) -> T, seed: T?): Observable.Transformer<(U...), (T)>
 	assert(type(accumulator) == "function", "Bad accumulator")
 
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
 		return Observable.new(function(sub)
-			local current = seed
+			local current: T? = seed
 
 			return source:Subscribe(function(...)
 				current = accumulator(current, ...)
 				sub:Fire(current)
 			end, sub:GetFailComplete())
-		end)
+		end) :: any
 	end
 end
 
@@ -747,12 +764,12 @@ function Rx.endWith(values)
 			maid:GiveTask(source:Subscribe(function(...)
 				sub:Fire(...)
 			end, function(...)
-				for _, item in pairs(values) do
+				for _, item in values do
 					sub:Fire(item)
 				end
 				sub:Fail(...)
 			end, function()
-				for _, item in pairs(values) do
+				for _, item in values do
 					sub:Fire(item)
 				end
 				sub:Complete()
@@ -778,10 +795,10 @@ end
 	@param predicate (value: T) -> boolean
 	@return (source: Observable<T>) -> Observable<T>
 ]=]
-function Rx.where(predicate)
+function Rx.where<T...>(predicate: Predicate<T...>): Observable.Transformer<T..., T...>
 	assert(type(predicate) == "function", "Bad predicate callback")
 
-	return function(source)
+	return function(source: Observable.Observable<T...>): Observable.Observable<T...>
 		assert(Observable.isObservable(source), "Bad observable")
 
 		return Observable.new(function(sub)
@@ -806,7 +823,7 @@ end
 	```
 	@return (source: Observable<T>) -> Observable<T>
 ]=]
-function Rx.distinct()
+function Rx.distinct<T...>(): Observable.Transformer<T..., T...>
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
@@ -822,7 +839,7 @@ function Rx.distinct()
 				last = value
 				sub:Fire(last)
 			end, sub:GetFailComplete())
-		end)
+		end) :: Observable.Observable<T...>
 	end
 end
 
@@ -860,7 +877,7 @@ end
 	@param project (T) -> U
 	@return (source: Observable<T>) -> Observable<U>
 ]=]
-function Rx.map(project)
+function Rx.map<T..., U...>(project: (T...) -> U...): Observable.Transformer<T..., U...>
 	assert(type(project) == "function", "Bad project callback")
 
 	return function(source)
@@ -870,7 +887,7 @@ function Rx.map(project)
 			return source:Subscribe(function(...)
 				sub:Fire(project(...))
 			end, sub:GetFailComplete())
-		end)
+		end) :: Observable.Observable<U...>
 	end
 end
 
@@ -891,7 +908,7 @@ end
 
 	@return (source: Observable<Observable<T>>) -> Observable<T>
 ]=]
-function Rx.mergeAll()
+function Rx.mergeAll<T...>(): Observable.Transformer<Observable.Observable<T...>, T...>
 	return Rx.flatMap(identity)
 end
 
@@ -906,7 +923,7 @@ end
 
 	@return (source: Observable<Observable<T>>) -> Observable<T>
 ]=]
-function Rx.switchAll()
+function Rx.switchAll<T...>(): Observable.Transformer<Observable.Observable<T...>, T...>
 	return Rx.switchMap(identity)
 end
 
@@ -918,16 +935,16 @@ end
 	@param project (value: T) -> Observable<U>
 	@return (source: Observable<T>) -> Observable<U>
 ]=]
-function Rx.flatMap(project)
+function Rx.flatMap<T..., U...>(project: (T...) -> Observable.Observable<U...>): Observable.Transformer<(T...), (U...)>
 	assert(type(project) == "function", "Bad project")
 
-	return function(source)
+	return function(source: Observable.Observable<T...>): Observable.Observable<U...>
 		assert(Observable.isObservable(source), "Bad observable")
 
-		return Observable.new(function(sub)
-			local isComplete = false
-			local pendingCount = 0
-			local subscriptions = {}
+		return Observable.new(function(sub: _Subscription.Subscription<U...>)
+			local isComplete: boolean = false
+			local pendingCount: number = 0
+			local subscriptions: Set<_Subscription.Subscription<U...>> = {}
 
 			local function checkComplete()
 				if isComplete and pendingCount == 0 then
@@ -935,8 +952,8 @@ function Rx.flatMap(project)
 				end
 			end
 
-			local function onNextObservable(...)
-				local observable = project(...)
+			local function onNextObservable(...: T...)
+				local observable: Observable.Observable<U...> = project(...)
 				assert(Observable.isObservable(observable), "Bad observable returned from subscription project call")
 
 				if not sub:IsPending() then
@@ -945,9 +962,9 @@ function Rx.flatMap(project)
 				end
 
 				local innerCompleteOrFail = false
-				local subscription
+				local subscription: _Subscription.Subscription<U...>? = nil
 
-				local function onNext(...)
+				local function onNext(...: U...)
 					if innerCompleteOrFail or pendingCount == 0 then
 						return
 					end
@@ -988,15 +1005,16 @@ function Rx.flatMap(project)
 				end
 
 				pendingCount += 1
-				subscription = observable:Subscribe(onNext, onFail, onComplete)
+				local newSub = observable:Subscribe(onNext, onFail, onComplete)
+				subscription = newSub
 
 				if innerCompleteOrFail or not sub:IsPending() then
 					-- Subscribing cancelled ourselves in some way
-					subscription:Destroy()
+					newSub:Destroy()
 					return
 				end
 
-				subscriptions[subscription] = true
+				subscriptions[newSub] = true
 			end
 
 			local outerSubscription = source:Subscribe(onNextObservable, function(...)
@@ -1009,13 +1027,13 @@ function Rx.flatMap(project)
 			return function()
 				pendingCount = 0
 
-				for subscription, _ in pairs(subscriptions) do
+				for subscription: any in subscriptions do
 					subscription:Destroy()
 				end
 
 				outerSubscription:Destroy()
 			end
-		end)
+		end) :: any
 	end
 end
 
@@ -1075,17 +1093,17 @@ end
 	@param project function
 	@return Observable
 ]=]
-function Rx.switchMap(project)
+function Rx.switchMap<T..., U...>(project: (T...) -> Observable.Observable<U...>): Observable.Transformer<(T...), (U...)>
 	assert(type(project) == "function", "Bad project")
 
-	return function(source)
+	return function(source: Observable.Observable<T...>)
 		assert(Observable.isObservable(source), "Bad observable")
 
-		return Observable.new(function(sub)
-			local isComplete = false
-			local insideComplete = false
-			local insideSubscription = nil
-			local outerIndex = 0
+		return Observable.new(function(sub: _Subscription.Subscription<U...>)
+			local isComplete: boolean = false
+			local insideComplete: boolean = false
+			local insideSubscription: _Subscription.Subscription<T...>? = nil
+			local outerIndex: number? = 0
 
 			local function checkComplete()
 				if isComplete and insideComplete then
@@ -1097,7 +1115,7 @@ function Rx.switchMap(project)
 			local function onNextObservable(...)
 				insideComplete = false
 
-				local observable = project(...)
+				local observable: Observable.Observable<U...> = project(...)
 				assert(Observable.isObservable(observable), "Bad observable returned from subscription project call")
 
 				-- Handle cancellation when external callers do weird state stuff
@@ -1119,7 +1137,7 @@ function Rx.switchMap(project)
 					return
 				end
 
-				local function onNext(...)
+				local function onNext(...: U...)
 					if index ~= outerIndex then
 						return
 					end
@@ -1155,7 +1173,7 @@ function Rx.switchMap(project)
 					return
 				end
 
-				insideSubscription = subscription
+				insideSubscription = subscription :: any
 			end
 
 			local outerSubscription = source:Subscribe(onNextObservable, function(...)
@@ -1176,7 +1194,7 @@ function Rx.switchMap(project)
 
 				outerSubscription:Destroy()
 			end
-		end)
+		end) :: Observable.Observable<U...>
 	end
 end
 
@@ -1226,13 +1244,14 @@ end
 	@param ... any
 	@return Observable
 ]=]
-function Rx.packed(...)
+function Rx.packed<T...>(...: T...): Observable.Observable<T...>
 	local args = table.pack(...)
 
 	return Observable.new(function(sub)
 		sub:Fire(unpack(args, 1, args.n))
 		sub:Complete()
-	end)
+		return
+	end) :: any
 end
 
 --[=[
@@ -1419,20 +1438,20 @@ end
 	@param observables { [TKey]: Observable<TEmitted> | TEmitted }
 	@return Observable<{ [TKey]: TEmitted }>
 ]=]
-function Rx.combineLatest(observables)
+function Rx.combineLatest<K, V>(observables: Map<K, Observable.Observable<V> | V>): Observable.Observable<Map<K, V>>
 	assert(type(observables) == "table", "Bad observables")
 
 	return Observable.new(function(sub)
 		local unset = 0
-		local latest = {}
+		local latest: Map<K, V> = {}
 
 		-- Instead of caching this, use extra compute here
-		for key, value in pairs(observables) do
+		for key, value in observables do
 			if Observable.isObservable(value) then
 				unset += 1
 				latest[key] = UNSET_VALUE
 			else
-				latest[key] = value
+				latest[key] = value :: V
 			end
 		end
 
@@ -1447,19 +1466,19 @@ function Rx.combineLatest(observables)
 
 		local function failOnFirst(...)
 			pending -= 1
-			latest = nil
+			latest = nil :: any
 			sub:Fail(...)
 		end
 
 		local function completeOnAllPendingDone()
 			pending -= 1
 			if pending == 0 then
-				latest = nil
+				latest = nil :: any
 				sub:Complete()
 			end
 		end
 
-		for key, observer in pairs(observables) do
+		for key, observer: any in observables do
 			if not Observable.isObservable(observer) then
 				continue
 			end
@@ -1478,7 +1497,7 @@ function Rx.combineLatest(observables)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -1495,10 +1514,10 @@ function Rx.combineLatestDefer(observables)
 	return Observable.new(function(sub)
 		local pending = 0
 		local unset = 0
-		local latest = {}
+		local latest: any = {}
 
 		-- Instead of caching this, use extra compute here
-		for key, value in pairs(observables) do
+		for key, value in observables do
 			if Observable.isObservable(value) then
 				pending += 1
 				unset += 1
@@ -1530,14 +1549,14 @@ function Rx.combineLatestDefer(observables)
 			end
 		end
 
-		local queueThread = nil
+		local queueThread: thread? = nil
 		maid:GiveTask(function()
 			if queueThread then
 				MaidTaskUtils.doTask(queueThread)
 			end
 		end)
 
-		for key, observer in pairs(observables) do
+		for key, observer in observables do
 			if not Observable.isObservable(observer) then
 				continue
 			end
@@ -1614,7 +1633,7 @@ end
 	@param number number
 	@return (source: Observable<T>) -> Observable<T>
 ]=]
-function Rx.take(number: number)
+function Rx.take<T...>(number: number): Observable.Transformer<T..., T...>
 	assert(type(number) == "number", "Bad number")
 	assert(number > 0, "Bad number")
 
@@ -1643,7 +1662,7 @@ function Rx.take(number: number)
 			end, sub:GetFailComplete())
 
 			return maid
-		end)
+		end) :: Observable.Observable<T...>
 	end
 end
 
@@ -1654,7 +1673,7 @@ end
 	@param toSkip number
 	@return (source: Observable<T>) -> Observable<T>
 ]=]
-function Rx.skip(toSkip: number)
+function Rx.skip<T...>(toSkip: number): Observable.Transformer<T..., T...>
 	assert(type(toSkip) == "number", "Bad toSkip")
 	assert(toSkip > 0, "Bad toSkip")
 
@@ -1675,7 +1694,7 @@ function Rx.skip(toSkip: number)
 			end, sub:GetFailComplete()))
 
 			return maid
-		end)
+		end) :: Observable.Observable<T...>
 	end
 end
 
@@ -1689,7 +1708,7 @@ end
 	@param observableFactory () -> Observable<T>
 	@return Observable<T>
 ]=]
-function Rx.defer(observableFactory)
+function Rx.defer<T>(observableFactory: () -> Observable.Observable<T>): Observable.Observable<T>
 	return Observable.new(function(sub)
 		local observable
 		local ok, err = pcall(function()
@@ -1707,7 +1726,7 @@ function Rx.defer(observableFactory)
 		end
 
 		return observable:Subscribe(sub:GetFireFailComplete())
-	end)
+	end) :: any
 end
 
 --[=[
@@ -1716,13 +1735,13 @@ end
 	@param seconds number
 	@return (source: Observable<T>) -> Observable<T>
 ]=]
-function Rx.delay(seconds: number)
+function Rx.delay<T...>(seconds: number): Observable.Transformer<T..., T...>
 	assert(type(seconds) == "number", "Bad seconds")
 
 	return function(source)
 		assert(Observable.isObservable(source), "Bad observable")
 
-		return Observable.new(function(sub)
+		return Observable.new(function(sub: _Subscription.Subscription<T...>)
 			local maid = Maid.new()
 
 			maid:GiveTask(source:Subscribe(function(...)
@@ -1735,7 +1754,7 @@ function Rx.delay(seconds: number)
 			end, sub:GetFailComplete()))
 
 			return maid
-		end)
+		end) :: Observable.Observable<T...>
 	end
 end
 
@@ -1811,7 +1830,7 @@ end
 function Rx.withLatestFrom(inputObservables)
 	assert(inputObservables, "Bad inputObservables")
 
-	for _, observable in pairs(inputObservables) do
+	for _, observable in inputObservables do
 		assert(Observable.isObservable(observable), "Bad observable")
 	end
 
@@ -1823,7 +1842,7 @@ function Rx.withLatestFrom(inputObservables)
 
 			local latest = {}
 
-			for key, observable in pairs(inputObservables) do
+			for key, observable in inputObservables do
 				latest[key] = UNSET_VALUE
 
 				maid:GiveTask(observable:Subscribe(function(value)
@@ -1832,7 +1851,7 @@ function Rx.withLatestFrom(inputObservables)
 			end
 
 			maid:GiveTask(source:Subscribe(function(value)
-				for _, item in pairs(latest) do
+				for _, item in latest do
 					if item == UNSET_VALUE then
 						return
 					end
@@ -1859,7 +1878,7 @@ end
 	@param throttleConfig { leading = true; trailing = true; }
 	@return (source: Observable) -> Observable
 ]=]
-function Rx.throttleTime(duration: number, throttleConfig)
+function Rx.throttleTime(duration: number, throttleConfig: ThrottledFunction.ThrottleConfig)
 	assert(type(duration) == "number", "Bad duration")
 	assert(type(throttleConfig) == "table" or throttleConfig == nil, "Bad throttleConfig")
 
@@ -1920,8 +1939,8 @@ function Rx.throttleDefer()
 		assert(Observable.isObservable(source), "Bad observable")
 
 		return Observable.new(function(sub)
-			local lastResult = nil
-			local currentQueue = nil
+			local lastResult: any = nil
+			local currentQueue: thread? = nil
 
 			local sourceSub = source:Subscribe(function(...)
 				if lastResult then
@@ -1972,7 +1991,7 @@ function Rx.throttle(durationSelector)
 		return Observable.new(function(sub)
 			local topMaid = Maid.new()
 
-			local lastResult
+			local lastResult: any
 
 			topMaid:GiveTask(source:Subscribe(function(...)
 				if not lastResult then
@@ -2115,7 +2134,7 @@ function Rx.switchScan(accumulator, seed)
 	assert(type(accumulator) == "function", "Bad accumulator")
 
 	return Rx.pipe({
-		Rx.scan(accumulator, seed),
+		Rx.scan(accumulator, seed) :: any,
 		Rx.switchAll(),
 	})
 end
@@ -2134,7 +2153,7 @@ function Rx.mergeScan(accumulator, seed)
 	assert(type(accumulator) == "function", "Bad accumulator")
 
 	return Rx.pipe({
-		Rx.scan(accumulator, seed),
+		Rx.scan(accumulator, seed) :: any,
 		Rx.mergeAll(),
 	})
 end

package/src/Shared/Subscription.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Subscriptions are used in the callback for an [Observable](/api/Observable). Standard usage
 	is as follows.
@@ -24,13 +25,40 @@ local Subscription = {}
 Subscription.ClassName = "Subscription"
 Subscription.__index = Subscription
 
-local SubscriptionStateTypes = {
-	PENDING = "pending";
-	FAILED = "failed";
-	COMPLETE = "complete";
-	CANCELLED = "cancelled";
+export type SubscriptionState = "pending" | "failed" | "complete" | "cancelled"
+
+export type FireCallback<T...> = (T...) -> ()
+export type CompleteCallback = () -> ()
+export type FailCallback = (...any) -> ()
+
+export type Subscription<T...> = typeof(setmetatable(
+	{} :: {
+		_state: SubscriptionState,
+		_cleanupTask: MaidTaskUtils.MaidTask?,
+		_fireCallback: FireCallback<T...>?,
+		_failCallback: FailCallback?,
+		_completeCallback: CompleteCallback?,
+		_fireCountAfterDeath: number?,
+		_source: string?,
+		_observableSource: string?,
+	},
+	Subscription
+))
+
+export type SubscriptionStateTypes = {
+	PENDING: "pending",
+	FAILED: "failed",
+	COMPLETE: "complete",
+	CANCELLED: "cancelled",
 }
 
+local SubscriptionStateTypes: SubscriptionStateTypes = table.freeze({
+	PENDING = "pending",
+	FAILED = "failed",
+	COMPLETE = "complete",
+	CANCELLED = "cancelled",
+} :: SubscriptionStateTypes)
+
 --[=[
 	Constructs a new Subscription
 
@@ -40,18 +68,23 @@ local SubscriptionStateTypes = {
 	@param observableSource string?
 	@return Subscription
 ]=]
-function Subscription.new(fireCallback, failCallback, completeCallback, observableSource)
+function Subscription.new<T...>(
+	fireCallback: FireCallback<T...>?,
+	failCallback: FailCallback?,
+	completeCallback: CompleteCallback?,
+	observableSource
+): Subscription<T...>
 	assert(type(fireCallback) == "function" or fireCallback == nil, "Bad fireCallback")
 	assert(type(failCallback) == "function" or failCallback == nil, "Bad failCallback")
 	assert(type(completeCallback) == "function" or completeCallback == nil, "Bad completeCallback")
 
 	return setmetatable({
-		_state = SubscriptionStateTypes.PENDING;
-		_source = if ENABLE_STACK_TRACING then debug.traceback("Subscription.new()", 3) else nil;
-		_observableSource = observableSource;
-		_fireCallback = fireCallback;
-		_failCallback = failCallback;
-		_completeCallback = completeCallback;
+		_state = SubscriptionStateTypes.PENDING,
+		_source = if ENABLE_STACK_TRACING then debug.traceback("Subscription.new()", 3) else nil,
+		_observableSource = observableSource,
+		_fireCallback = fireCallback,
+		_failCallback = failCallback,
+		_completeCallback = completeCallback,
 	}, Subscription)
 end
 
@@ -60,7 +93,7 @@ end
 
 	@param ... any
 ]=]
-function Subscription:Fire(...)
+function Subscription.Fire<T...>(self: Subscription<T...>, ...: T...)
 	if self._state == SubscriptionStateTypes.PENDING then
 		if self._fireCallback then
 			self._fireCallback(...)
@@ -73,7 +106,16 @@ function Subscription:Fire(...)
 		end
 
 		if self._fireCountAfterDeath > 1 then
-			warn(debug.traceback(string.format("Subscription:Fire(%s) called %d times after death. Be sure to disconnect all events.", tostring(...), self._fireCountAfterDeath), 2))
+			warn(
+				debug.traceback(
+					string.format(
+						"Subscription:Fire(%s) called %d times after death. Be sure to disconnect all events.",
+						(tostring :: any)(...),
+						self._fireCountAfterDeath or -1
+					),
+					2
+				)
+			)
 
 			if ENABLE_STACK_TRACING then
 				print(self._observableSource)
@@ -87,7 +129,7 @@ end
 	Fails the subscription, preventing anything else from emitting.
 	@param ... any
 ]=]
-function Subscription:Fail(...)
+function Subscription.Fail<T...>(self: Subscription<T...>, ...: any)
 	if self._state ~= SubscriptionStateTypes.PENDING then
 		return
 	end
@@ -101,7 +143,6 @@ function Subscription:Fail(...)
 	self:_doCleanup()
 end
 
-
 --[=[
 	Returns a tuple of fire, fail and complete functions which
 	can be chained into the the next subscription.
@@ -120,8 +161,10 @@ end
 	@return function
 	@return function
 ]=]
-function Subscription:GetFireFailComplete()
-	return function(...)
+function Subscription.GetFireFailComplete<T...>(
+	self: Subscription<T...>
+): (FireCallback<T...>, FailCallback, CompleteCallback)
+	return function(...: T...)
 		self:Fire(...)
 	end, function(...)
 		self:Fail(...)
@@ -147,7 +190,7 @@ end
 	@return function
 	@return function
 ]=]
-function Subscription:GetFailComplete()
+function Subscription.GetFailComplete<T...>(self: Subscription<T...>): (FailCallback, CompleteCallback)
 	return function(...)
 		self:Fail(...)
 	end, function(...)
@@ -161,7 +204,7 @@ end
 
 	@param ... any
 ]=]
-function Subscription:Complete(...)
+function Subscription.Complete<T...>(self: Subscription<T...>, ...)
 	if self._state ~= SubscriptionStateTypes.PENDING then
 		return
 	end
@@ -178,11 +221,11 @@ end
 	Returns whether the subscription is pending.
 	@return boolean
 ]=]
-function Subscription:IsPending()
+function Subscription.IsPending<T...>(self: Subscription<T...>): boolean
 	return self._state == SubscriptionStateTypes.PENDING
 end
 
-function Subscription:_assignCleanup(cleanupTask)
+function Subscription._assignCleanup<T...>(self: Subscription<T...>, cleanupTask: MaidTaskUtils.MaidTask?)
 	assert(self._cleanupTask == nil, "Already have _cleanupTask")
 
 	if MaidTaskUtils.isValidTask(cleanupTask) then
@@ -197,7 +240,7 @@ function Subscription:_assignCleanup(cleanupTask)
 	end
 end
 
-function Subscription:_doCleanup()
+function Subscription._doCleanup<T...>(self: Subscription<T...>)
 	local cleanupTask = self._cleanupTask
 	if cleanupTask then
 		self._cleanupTask = nil
@@ -221,7 +264,7 @@ end
 	be called within the usage of a subscription.
 	:::
 ]=]
-function Subscription:Destroy()
+function Subscription.Destroy<T...>(self: Subscription<T...>)
 	if self._state == SubscriptionStateTypes.PENDING then
 		self._state = SubscriptionStateTypes.CANCELLED
 	end
@@ -231,9 +274,10 @@ end
 
 --[=[
 	Alias for [Subscription.Destroy].
+
+	@method Disconnect
+	@within Subscription
 ]=]
-function Subscription:Disconnect()
-	self:Destroy()
-end
+Subscription.Disconnect = Subscription.Destroy
 
 return Subscription