Skip to main content

Subscription

Subscriptions are used in the callback for an Observable. Standard usage is as follows. 

-- Constucts an observable which will emit a, b, c via a subscription
Observable.new(function(sub)
	sub:Fire("a")
	sub:Fire("b")
	sub:Fire("c")
	sub:Complete() -- ends stream
end)

Functions​

new​

</>
Subscription.new(
fireCallback: function?,
failCallback: function?,
completeCallback: function?,
observableSource: string?
) → Subscription

Constructs a new Subscription

Fire​

</>
Subscription:Fire(...: any) → ()

Fires the subscription

Fail​

</>
Subscription:Fail() → ()

Fails the subscription, preventing anything else from emitting.

GetFireFailComplete​

</>
Subscription:GetFireFailComplete() → (
function,
function,
function
)

Returns a tuple of fire, fail and complete functions which can be chained into the the next subscription. 

return function(source)
	return Observable.new(function(sub)
		sub:Fire("hi")

		return source:Subscribe(sub:GetFireFailComplete())
	end)
end

GetFailComplete​

</>
Subscription:GetFailComplete() → (
function,
function
)

Returns a tuple of fail and complete functions which can be chained into the the next subscription. 

return function(source)
	return Observable.new(function(sub)
		return source:Subscribe(function(result)
			sub:Fire(tostring(result))
		end, sub:GetFailComplete()) -- Reuse is easy here!
	end)
end

Complete​

</>
Subscription:Complete() → ()

Completes the subscription, preventing anything else from being emitted.

IsPending​

</>
Subscription:IsPending() → boolean

Returns whether the subscription is pending.

Destroy​

</>
Subscription:Destroy() → ()

Cleans up the subscription

tip

This will be invoked by the Observable automatically, and should not be called within the usage of a subscription.

Disconnect​

</>
Subscription:Disconnect() → ()
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new Subscription",
            "params": [
                {
                    "name": "fireCallback",
                    "desc": "",
                    "lua_type": "function?"
                },
                {
                    "name": "failCallback",
                    "desc": "",
                    "lua_type": "function?"
                },
                {
                    "name": "completeCallback",
                    "desc": "",
                    "lua_type": "function?"
                },
                {
                    "name": "observableSource",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Subscription"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "Fire",
            "desc": "Fires the subscription",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "Fail",
            "desc": "Fails the subscription, preventing anything else from emitting.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 89,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "GetFireFailComplete",
            "desc": "Returns a tuple of fire, fail and complete functions which\ncan be chained into the the next subscription.\n\n```lua\nreturn function(source)\n\treturn Observable.new(function(sub)\n\t\tsub:Fire(\"hi\")\n\n\t\treturn source:Subscribe(sub:GetFireFailComplete())\n\tend)\nend\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 122,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "GetFailComplete",
            "desc": "Returns a tuple of fail and complete functions which\ncan be chained into the the next subscription.\n\n```lua\nreturn function(source)\n\treturn Observable.new(function(sub)\n\t\treturn source:Subscribe(function(result)\n\t\t\tsub:Fire(tostring(result))\n\t\tend, sub:GetFailComplete()) -- Reuse is easy here!\n\tend)\nend\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "function"
                },
                {
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 149,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "Complete",
            "desc": "Completes the subscription, preventing anything else from being\nemitted.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 161,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "IsPending",
            "desc": "Returns whether the subscription is pending.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 178,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Cleans up the subscription\n\n:::tip\nThis will be invoked by the Observable automatically, and should not\nbe called within the usage of a subscription.\n:::",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 221,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        },
        {
            "name": "Disconnect",
            "desc": "Alias for [Subscription.Destroy].",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 233,
                "path": "src/rx/src/Shared/Subscription.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Subscription",
    "desc": "Subscriptions are used in the callback for an [Observable](/api/Observable). Standard usage\nis as follows.\n\n```lua\n-- Constucts an observable which will emit a, b, c via a subscription\nObservable.new(function(sub)\n\tsub:Fire(\"a\")\n\tsub:Fire(\"b\")\n\tsub:Fire(\"c\")\n\tsub:Complete() -- ends stream\nend)\n```",
    "source": {
        "line": 16,
        "path": "src/rx/src/Shared/Subscription.lua"
    }
}