shareReplay docs page should explain parameters #7515
nivomi
started this conversation in
Report issues other than bug
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hello there!
I was looking to do some boring caching stuff, and found the docs page for shareReplay very lacking in detail.
Specifically, for
shareReplay(bufferSize?: number, windowTime?: number, scheduler?: SchedulerLike)
:bufferSize
parameter? (this can be intuited contextually, but isn't explained in the 'parameters' box)windowTime
parameter? It's a number, but what units? Seconds? Milliseconds?scheduler
parameter? What's the behaviour if it isn't provided? Sure, it defaults to undefined, but does that make rxjs use some default scheduler, or does that make the windowTime parameter do nothing, or...?Also, there's a "suggest edits" button at the top of the page that just doesn't do anything...?
Beta Was this translation helpful? Give feedback.
All reactions