Skip to main content

RxSignal

Functions​

new​

</>
RxSignal.new(observable: Observable<T> | () → Observable<T>) → RxSignal<T>

Converts an observable to the Signal interface

Connect​

</>
RxSignal.Connect(
self: RxSignal<T...>,
callback: (T...) → ()
) → _Subscription.Subscription<T...>

Connects to the signal and returns a subscription

Wait​

</>
RxSignal.Wait(self: RxSignal<T...>) → T...

Waits for the signal to fire and returns the values

Once​

</>
RxSignal.Once(
self: RxSignal<T...>,
callback: (T...) → ()
) → _Subscription.Subscription<T...>

Connects once to the signal and returns a subscription

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Converts an observable to the Signal interface",
            "params": [
                {
                    "name": "observable",
                    "desc": "",
                    "lua_type": "Observable<T> | () -> Observable<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RxSignal<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "src/rxsignal/src/Shared/RxSignal.lua"
            }
        },
        {
            "name": "Connect",
            "desc": "Connects to the signal and returns a subscription",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RxSignal<T...>"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(T...) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "_Subscription.Subscription<T...>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 42,
                "path": "src/rxsignal/src/Shared/RxSignal.lua"
            }
        },
        {
            "name": "Wait",
            "desc": "Waits for the signal to fire and returns the values",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RxSignal<T...>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T...\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/rxsignal/src/Shared/RxSignal.lua"
            }
        },
        {
            "name": "Once",
            "desc": "Connects once to the signal and returns a subscription",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "RxSignal<T...>"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "(T...) -> ()"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "_Subscription.Subscription<T...>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/rxsignal/src/Shared/RxSignal.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxSignal",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/rxsignal/src/Shared/RxSignal.lua"
    }
}