Skip to content

fix: missing documentation for ObservableList #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrkboy10 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: missing documentation for ObservableList #565

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b18ba20
Update ObservableList.lua
mrkboy10 Jun 10, 2025
b469e03
Update ObservableList.lua (2)
mrkboy10 Jun 10, 2025
ec9b74c
Use correct type definition for Symbol
mrkboy10 Jun 10, 2025
ee910b1
Merge branch 'main' into fix-missing-documentation-observable-list
Quenty Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions src/observablecollection/src/Shared/ObservableList.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,8 @@ export type ObservableList<T> = typeof(setmetatable(
_keyIndexObservables: any, -- ObservableSubscriptionTable.ObservableSubscriptionTable<number?>,
_countValue: ValueObject.ValueObject<number>,

--[=[
Fires when an item is added
@readonly
@prop ItemAdded Signal<T, number, Symbol>
@within ObservableList
]=]
ItemAdded: Signal.Signal<T, number, Symbol.Symbol>,

--[=[
Fires when an item is removed.
@readonly
@prop ItemRemoved Signal<T, Symbol>
@within ObservableList
]=]
ItemRemoved: Signal.Signal<T, Symbol.Symbol>,

--[=[
Fires when the count changes.
@prop CountChanged Signal.Signal<number>,
@within ObservableList
]=]
CountChanged: Signal.Signal<number>,
},
{} :: typeof({ __index = ObservableList })
Expand All @@ -75,8 +56,27 @@ function ObservableList.new<T>(): ObservableList<T>
self._keyIndexObservables = self._maid:Add(ObservableSubscriptionTable.new())
self._countValue = self._maid:Add(ValueObject.new(0, "number"))

--[=[
Fires when an item is added
@readonly
@prop ItemAdded Signal<T, number, Symbol>
@within ObservableList
]=]
self.ItemAdded = self._maid:Add(Signal.new() :: any)

--[=[
Fires when an item is removed.
@readonly
@prop ItemRemoved Signal<T, Symbol>
@within ObservableList
]=]
self.ItemRemoved = self._maid:Add(Signal.new() :: any)

--[=[
Fires when the count changes.
@prop CountChanged Signal<number>
@within ObservableList
]=]
self.CountChanged = self._countValue.Changed :: any

return self
Expand Down Expand Up @@ -133,9 +133,9 @@ end

--[=[
Observes all items in the list
@return Observable<Brio<T>>
@return Observable<Brio<T, Symbol>>
]=]
function ObservableList.ObserveItemsBrio<T>(self: ObservableList<T>): Observable.Observable<Brio.Brio<T>>
function ObservableList.ObserveItemsBrio<T>(self: ObservableList<T>): Observable.Observable<Brio.Brio<T, Symbol.Symbol>>
return Observable.new(function(sub)
local maid = Maid.new()

Expand Down
Loading