Show raw api
{
"functions": [
{
"name": "pipe",
"desc": "Pipes the tranformers through each other\nhttps://rxjs-dev.firebaseapp.com/api/index/function/pipe",
"params": [
{
"name": "transformers",
"desc": "",
"lua_type": "{ Observable<any> }"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<U>"
}
],
"function_type": "static",
"source": {
"line": 55,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "of",
"desc": "http://reactivex.io/documentation/operators/just.html\n\n```lua\nRx.of(1, 2, 3):Subscribe(print, function()\n\tprint(\"Complete\")\nend)) --> 1, 2, 3, \"Complete\"\n```",
"params": [
{
"name": "...",
"desc": "Arguments to emit",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 91,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "failed",
"desc": "Returns a failed observable",
"params": [
{
"name": "...",
"desc": "Failure args",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 109,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "from",
"desc": "Converts an item\nhttp://reactivex.io/documentation/operators/from.html",
"params": [
{
"name": "item",
"desc": "",
"lua_type": "Promise | table"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 124,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "toPromise",
"desc": "Converts a promise to an observable.",
"params": [
{
"name": "observable",
"desc": "",
"lua_type": "Observable<T>"
},
{
"name": "cancelToken",
"desc": "",
"lua_type": "CancelToken?"
}
],
"returns": [
{
"desc": "",
"lua_type": "Promise<T>"
}
],
"function_type": "static",
"source": {
"line": 141,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "merge",
"desc": "https://rxjs-dev.firebaseapp.com/api/operators/merge",
"params": [
{
"name": "observables",
"desc": "",
"lua_type": "{ Observable }"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 183,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "fromSignal",
"desc": "Converts a Signal into an observable.\nhttps://rxjs-dev.firebaseapp.com/api/index/function/fromEvent",
"params": [
{
"name": "event",
"desc": "",
"lua_type": "Signal<T>"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 222,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "fromPromise",
"desc": "Converts a Promise into an observable.\nhttps://rxjs-dev.firebaseapp.com/api/index/function/from",
"params": [
{
"name": "promise",
"desc": "",
"lua_type": "Promise<T>"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 238,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "tap",
"desc": "Taps into the observable and executes the onFire/onError/onComplete\ncommands.\n\nhttps://rxjs-dev.firebaseapp.com/api/operators/tap",
"params": [
{
"name": "onFire",
"desc": "",
"lua_type": "function?"
},
{
"name": "onError",
"desc": "",
"lua_type": "function?"
},
{
"name": "onComplete",
"desc": "",
"lua_type": "function?"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 284,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "start",
"desc": "Starts the observable with the given value from the callback\n\nhttp://reactivex.io/documentation/operators/start.html",
"params": [
{
"name": "callback",
"desc": "",
"lua_type": "function"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 326,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "share",
"desc": "Returns a new Observable that multicasts (shares) the original Observable. As long as there is at least one Subscriber this Observable will be subscribed and emitting data.\nWhen all subscribers have unsubscribed it will unsubscribe from the source Observable.\n\nhttps://rxjs.dev/api/operators/share",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 346,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "shareReplay",
"desc": "Same as [Rx.share] except it also replays the value",
"params": [
{
"name": "bufferSize",
"desc": "Number of entries to cache",
"lua_type": "number"
},
{
"name": "windowTimeSeconds",
"desc": "Time",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 421,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "cache",
"desc": "Caches the current value",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 544,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "startFrom",
"desc": "Like start, but also from (list!)",
"params": [
{
"name": "callback",
"desc": "",
"lua_type": "() -> { T }"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 554,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "startWith",
"desc": "Starts with the given values\nhttps://rxjs-dev.firebaseapp.com/api/operators/startWith",
"params": [
{
"name": "values",
"desc": "",
"lua_type": "{ T }"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 576,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "scan",
"desc": "The Scan operator applies a function to the first item emitted by the source Observable and then\nemits the result of that function as its own first emission. It also feeds the result of the function\nback into the function along with the second item emitted by the source Observable in order to generate\nits second emission. It continues to feed back its own subsequent emissions along with the subsequent\nemissions from the source Observable in order to create the rest of its sequence.\n\nhttps://reactivex.io/documentation/operators/scan.html",
"params": [
{
"name": "accumulator",
"desc": "",
"lua_type": "function"
},
{
"name": "seed",
"desc": "",
"lua_type": "any | nil"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 605,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "reduce",
"desc": "The Reduce operator applies a function to the first item emitted by the source Observable and\nthen feeds the result of the function back into the function along with the second item emitted\nby the source Observable, continuing this process until the source Observable emits its final\nitem and completes, whereupon the Observable returned from Reduce emits the final value returned\nfrom the function.\n\nhttps://reactivex.io/documentation/operators/reduce.html",
"params": [
{
"name": "reducer",
"desc": "",
"lua_type": "function"
},
{
"name": "seed",
"desc": "",
"lua_type": "any | nil"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 635,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "defaultsTo",
"desc": "Defaults the observable to a value if it isn't fired immediately\n\n```lua\nRx.NEVER:Pipe({\n\tRx.defaultsTo(\"Hello\")\n}):Subscribe(print) --> Hello\n```\n\nIf empty (or failed) the the sub will fire with the value before it completes.",
"params": [
{
"name": "value",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 676,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "defaultsToNil",
"desc": "Defaults the observable value to nil\n\n```lua\nRx.NEVER:Pipe({\n\tRx.defaultsToNil\n}):Subscribe(print) --> nil\n```\n\nGreat for defaulting Roblox attributes and objects",
"params": [
{
"name": "source",
"desc": "",
"lua_type": "Observable"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 731,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "endWith",
"desc": "Ends the observable with these values before cancellation\nhttps://www.learnrxjs.io/learn-rxjs/operators/combination/endwith",
"params": [
{
"name": "values",
"desc": "",
"lua_type": "{ T }"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 740,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "where",
"desc": "http://reactivex.io/documentation/operators/filter.html\n\nFilters out values\n\n```lua\nRx.of(1, 2, 3, 4, 5):Pipe({\n\tRx.where(function(value)\n\t\treturn value % 2 == 0;\n\tend)\n}):Subscribe(print) --> 2, 4\n```",
"params": [
{
"name": "predicate",
"desc": "",
"lua_type": "(value: T) -> boolean"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 784,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "distinct",
"desc": "Only takes distinct values from the observable stream.\n\nhttp://reactivex.io/documentation/operators/distinct.html\n\n```lua\nRx.of(1, 1, 2, 3, 3, 1):Pipe({\n\tRx.distinct();\n}):Subscribe(print) --> 1, 2, 3, 1\n```",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 815,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "mapTo",
"desc": "https://rxjs.dev/api/operators/mapTo",
"params": [
{
"name": "...",
"desc": "The value to map each source value to.",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 843,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "map",
"desc": "http://reactivex.io/documentation/operators/map.html\n\nMaps one value to another\n\n```lua\nRx.of(1, 2, 3, 4, 5):Pipe({\n\tRx.map(function(x)\n\t\treturn x + 1\n\tend)\n}):Subscribe(print) -> 2, 3, 4, 5, 6\n```",
"params": [
{
"name": "project",
"desc": "",
"lua_type": "(T) -> U"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<U>"
}
],
"function_type": "static",
"source": {
"line": 872,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "mergeAll",
"desc": "Merges higher order observables together.\n\nBasically, if you have an observable that is emitting an observable,\nthis subscribes to each emitted observable and combines them into a\nsingle observable.\n\n```lua\nRx.of(Rx.of(1, 2, 3), Rx.of(4))\n\t:Pipe({\n\t\tRx.mergeAll();\n\t})\n\t:Subscribe(print) -> 1, 2, 3, 4\n```",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<Observable<T>>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 903,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "switchAll",
"desc": "Merges higher order observables together\n\nhttps://rxjs.dev/api/operators/switchAll\n\nWorks like mergeAll, where you subscribe to an observable which is\nemitting observables. However, when another observable is emitted it\ndisconnects from the other observable and subscribes to that one.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<Observable<T>>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 983,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "flatMap",
"desc": "Sort of equivalent of promise.then()\n\nThis takes a stream of observables",
"params": [
{
"name": "project",
"desc": "",
"lua_type": "(value: T) -> Observable<U>"
},
{
"name": "resultSelector",
"desc": "",
"lua_type": "((initialValue: T, outputValue: U) -> U)?"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<U>"
}
],
"function_type": "static",
"source": {
"line": 1066,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "switchMap",
"desc": "Switches to a new observable from the current observable\n\nhttps://rxjs.dev/api/operators/switchMap\n\nAs each observable shows up, a new observable is mapped from that observable.\n\nThe old observable is disconnected.\n\nUse Rx.switchMap to switch to a new RunService event\n\n```lua\nRx.of(1, 2, 3):Pipe({\n\tRx.switchMap(function(value)\n\t\tlocal startTime = os.clock()\n\n\t\t-- Only the last observable returned will continue to emit,\n\t\t-- others are disconnected.\n\t\treturn Rx.of(RunService.RenderStepped):Pipe({\n\t\t\tRx.map(function()\n\t\t\t\treturn os.clock() - startTime, value\n\t\t\tend);\n\t\t});\n\tend);\n}):Subscribe(print) --> 0.002352342, 3\n```\n\nUse Rx.switchMap() as a simple map...\n\n```lua\nRx.of(1, 2, 3):Pipe({\n\tRx.switchMap(function(value)\n\t\tprint(value) --> 1 (and then 2, and then 3)\n\n\t\treturn Rx.of(value*2)\n\tend);\n}):Subscribe(print) --> 2, 4, 6\n\n```\n\nUse Rx.switchMap() with delayed input (to swap to a new one)\n\n```lua\nRx.of(1, 2, 3):Pipe({\n\tRx.switchMap(function(value)\n\t\t-- Emit 1 second later\n\t\treturn Rx.of(value*2):Pipe({\n\t\t\tRx.delay(1); -- These will each get cancelled\n\t\t})\n\tend);\n}):Subscribe(print) --> 6 (other results were cancelled)\n```",
"params": [
{
"name": "project",
"desc": "",
"lua_type": "function"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 1194,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "packed",
"desc": "Returns an observable that takes in a tuple, and emits that tuple, then\ncompletes.\n\n```lua\nRx.packed(\"a\", \"b\")\n\t:Subscribe(function(first, second)\n\t\tprint(first, second) --> a, b\n\tend)\n```",
"params": [
{
"name": "...",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable"
}
],
"function_type": "static",
"source": {
"line": 1247,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "unpacked",
"desc": "Unpacks the observables value if a table is received",
"params": [
{
"name": "observable",
"desc": "",
"lua_type": "Observable<{T}>"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1261,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "finalize",
"desc": "Acts as a finalizer callback once the subscription is unsubscribed.\n\n```lua\n\tRx.of(\"a\", \"b\"):Pipe({\n\t\tRx.finalize(function()\n\t\t\tprint(\"Subscription done!\")\n\t\tend);\n\t})\n```\n\nhttp://reactivex.io/documentation/operators/do.html\nhttps://rxjs-dev.firebaseapp.com/api/operators/finalize\nhttps://github.com/ReactiveX/rxjs/blob/master/src/internal/operators/finalize.ts",
"params": [
{
"name": "finalizerCallback",
"desc": "",
"lua_type": "() -> ()"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1293,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "combineLatestAll",
"desc": "Given an observable that emits observables, emit an\nobservable that once the initial observable completes,\nthe latest values of each emitted observable will be\ncombined into an array that will be emitted.\n\nhttps://rxjs.dev/api/operators/combineLatestAll",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<Observable<T>>) -> Observable<{ T }>"
}
],
"function_type": "static",
"source": {
"line": 1320,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "combineAll",
"desc": "The same as combineLatestAll.\n\nThis is for backwards compatability, and is deprecated.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<Observable<T>>) -> Observable<{ T }>"
}
],
"function_type": "static",
"deprecated": {
"version": "1.0.0",
"desc": "Use Rx.combineLatestAll"
},
"source": {
"line": 1366,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "catchError",
"desc": "Catches an error, and allows another observable to be subscribed\nin terms of handling the error.\n\n:::warning\nThis method is not yet tested\n:::",
"params": [
{
"name": "callback",
"desc": "",
"lua_type": "(error: TError) -> Observable<TErrorResult>"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T | TErrorResult>"
}
],
"function_type": "static",
"source": {
"line": 1379,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "combineLatest",
"desc": "One of the most useful functions this combines the latest values of\nobservables at each chance!\n\n```lua\nRx.combineLatest({\n\tchild = Rx.fromSignal(Workspace.ChildAdded);\n\tlastChildRemoved = Rx.fromSignal(Workspace.ChildRemoved);\n\tvalue = 5;\n\n}):Subscribe(function(data)\n\tprint(data.child) --> last child\n\tprint(data.lastChildRemoved) --> other value\n\tprint(data.value) --> 5\nend)\n\n```\n\n:::tip\nNote that the resulting observable will not emit until all input\nobservables are emitted.\n:::",
"params": [
{
"name": "observables",
"desc": "",
"lua_type": "{ [TKey]: Observable<TEmitted> | TEmitted }"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<{ [TKey]: TEmitted }>"
}
],
"function_type": "static",
"source": {
"line": 1447,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "combineLatestDefer",
"desc": "Equivalent of [Rx.combineLatest] and [Rx.throttleDefer] but avoids copying and emitting a new table\nuntil after the frame ends. Helpful in scenarios where we write multiple times to a single value in a\nframe, and we don't want to create a lot of work for the garbage collector.",
"params": [
{
"name": "observables",
"desc": "",
"lua_type": "{ [TKey]: Observable<TEmitted> | TEmitted }"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<{ [TKey]: TEmitted }>"
}
],
"function_type": "static",
"source": {
"line": 1520,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "using",
"desc": "http://reactivex.io/documentation/operators/using.html\n\nEach time a subscription occurs, the resource is constructed\nand exists for the lifetime of the observation. The observableFactory\nuses the resource for subscription.\n\n:::note\nNote from Quenty: I haven't found this that useful.\n:::",
"params": [
{
"name": "resourceFactory",
"desc": "",
"lua_type": "() -> MaidTask"
},
{
"name": "observableFactory",
"desc": "",
"lua_type": "(MaidTask) -> Observable<T>"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1612,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "first",
"desc": "Takes the first entry and terminates the observable. Equivalent to the following:\n\n```lua\nRx.take(1)\n```\n\nhttps://reactivex.io/documentation/operators/first.html",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1638,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "take",
"desc": "Takes n entries and then completes the observation.\n\nhttps://rxjs.dev/api/operators/take",
"params": [
{
"name": "number",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1649,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "skip",
"desc": "Takes n entries and then completes the observation.\n\nhttps://rxjs.dev/api/operators/take",
"params": [
{
"name": "toSkip",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1689,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "defer",
"desc": "Defers the subscription and creation of the observable until the\nactual subscription of the observable.\n\nhttps://rxjs-dev.firebaseapp.com/api/index/function/defer\nhttps://netbasal.com/getting-to-know-the-defer-observable-in-rxjs-a16f092d8c09",
"params": [
{
"name": "observableFactory",
"desc": "",
"lua_type": "() -> Observable<T>"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1724,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "delay",
"desc": "Shift the emissions from an Observable forward in time by a particular amount.",
"params": [
{
"name": "seconds",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1751,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "delayed",
"desc": "Creates an observable that will emit N seconds later.",
"params": [
{
"name": "seconds",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Observable<()>"
}
],
"function_type": "static",
"source": {
"line": 1780,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "timer",
"desc": "Emits output every `n` seconds",
"params": [
{
"name": "initialDelaySeconds",
"desc": "",
"lua_type": "number"
},
{
"name": "seconds",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<number>) -> Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 1797,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "interval",
"desc": "https://www.learnrxjs.io/learn-rxjs/operators/creation/interval",
"params": [
{
"name": "seconds",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<number>) -> Observable<number>"
}
],
"function_type": "static",
"source": {
"line": 1828,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "withLatestFrom",
"desc": "Honestly, I have not used this one much.\n\nhttps://rxjs-dev.firebaseapp.com/api/operators/withLatestFrom\nhttps://medium.com/js-in-action/rxjs-nosy-combinelatest-vs-selfish-withlatestfrom-a957e1af42bf",
"params": [
{
"name": "inputObservables",
"desc": "",
"lua_type": "{Observable<TInput>}"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<{T, ...TInput}>"
}
],
"function_type": "static",
"source": {
"line": 1843,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "throttleTime",
"desc": "Throttles emission of observables.\n\nhttps://rxjs-dev.firebaseapp.com/api/operators/throttleTime\n\n:::note\nNote that on complete, the last item is not included, for now, unlike the existing version in rxjs.\n:::",
"params": [
{
"name": "duration",
"desc": "",
"lua_type": "number"
},
{
"name": "throttleConfig",
"desc": "",
"lua_type": "{ leading = true; trailing = true; }"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 1894,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "onlyAfterDefer",
"desc": "Only emits events after the deferred first signal.",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 1923,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "throttleDefer",
"desc": "Throttles emission of observables on the defer stack to the last emission.\n\n:::tip\nThere's a limited re-entrance amount for this. However, this can prevent computation being done repeatedly if\nstuff is being added all at once. Use with care.\n:::",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 1950,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "throttle",
"desc": "Throttles emission of observables on the defer stack to the last emission.\n\nhttps://rxjs.dev/api/operators/throttle",
"params": [
{
"name": "durationSelector",
"desc": "",
"lua_type": "(T: value) -> Observable"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable<T>) -> Observable<T>"
}
],
"function_type": "static",
"source": {
"line": 1998,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "skipUntil",
"desc": "Skips over values emitted by the source observable until a passed-in notifier observable emits a value.\n\nhttps://rxjs.dev/api/operators/skipUntil",
"params": [
{
"name": "notifier",
"desc": "",
"lua_type": "Observable"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 2048,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "skipWhile",
"desc": "Skips over values emitted by the source observable as long as the given predicate is true.\n\nhttps://rxjs.dev/api/index/function/skipWhile",
"params": [
{
"name": "predicate",
"desc": "",
"lua_type": "(index: number, ...: any) -> boolean"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 2082,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "takeWhile",
"desc": "Emits values from the source observable as long as the given predicate is true. Completes if the predicate is false.\n\nhttps://rxjs.dev/api/index/function/takeWhile",
"params": [
{
"name": "predicate",
"desc": "",
"lua_type": "(index: number, ...: any) -> boolean"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 2114,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "switchScan",
"desc": "Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable,\nemitting values only from the most recently returned Observable.\n\nhttps://rxjs.dev/api/index/function/switchScan",
"params": [
{
"name": "accumulator",
"desc": "",
"lua_type": "function"
},
{
"name": "seed",
"desc": "",
"lua_type": "any | nil"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 2146,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "mergeScan",
"desc": "Applies an accumulator function over the source Observable where the accumulator function itself returns an Observable,\nthen each intermediate Observable returned is merged into the output Observable.\n\nhttps://rxjs.dev/api/operators/mergeScan",
"params": [
{
"name": "accumulator",
"desc": "",
"lua_type": "function"
},
{
"name": "seed",
"desc": "",
"lua_type": "any | nil"
}
],
"returns": [
{
"desc": "",
"lua_type": "(source: Observable) -> Observable"
}
],
"function_type": "static",
"source": {
"line": 2165,
"path": "src/rx/src/Shared/Rx.lua"
}
}
],
"properties": [
{
"name": "EMPTY",
"desc": "An empty observable that completes immediately",
"lua_type": "Observable<()>",
"readonly": true,
"source": {
"line": 32,
"path": "src/rx/src/Shared/Rx.lua"
}
},
{
"name": "NEVER",
"desc": "An observable that never completes.",
"lua_type": "Observable<()>",
"readonly": true,
"source": {
"line": 39,
"path": "src/rx/src/Shared/Rx.lua"
}
}
],
"types": [],
"name": "Rx",
"desc": "Observable rx library for Roblox by Quenty. This provides a variety of\ncomposition classes to be used, and is the primary entry point for an\nobservable.\n\nMost of these functions return either a function that takes in an\nobservable (curried for piping) or an [Observable](/api/Observable)\ndirectly.",
"source": {
"line": 12,
"path": "src/rx/src/Shared/Rx.lua"
}
}