Skip to content

docs(aio): Added developer guide on RxJS #16452

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.

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

Closed
wants to merge 1 commit into from

Conversation

brandonroberts
Copy link
Contributor

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (check one with "x")

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Other... Please describe:

Developer guide on observable usage. This was migrated over from angular/angular.io#3047

What is the current behavior? (You can also link to an open issue here)

What is the new behavior?

Does this PR introduce a breaking change? (check one with "x")

[ ] Yes
[ ] No

If this PR contains a breaking change, please describe the impact and migration path for existing applications: ...

Other information:

@mary-poppins
Copy link

The angular.io preview for 49b1b70 is available here.

@mary-poppins
Copy link

The angular.io preview for 7d15413 is available here.

@mary-poppins
Copy link

The angular.io preview for 1afc491 is available here.

@mary-poppins
Copy link

The angular.io preview for a481925 is available here.

},

{
"url": "guide/pipes",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it intentional that pipes are added here, while they are already present above (around line 188)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it. Probably happened during a rebase.

Copy link
Member

@Foxandxss Foxandxss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is the plunker? Rxjs is a complex subject and there is a lot of examples that you don't know what kind of output to expect.

Continuing on that, there are a few simple snippets that could use some comments saying what is the expected output.

I saw you named hot and cold but there is no more on it. A link would be nice.

There is a part where you give a few resources link. That is better to be at the end. To not distract people from reading your guide.

I find the first part (Observable is a function) to be too complicated.




**Observables** are a programming technique for handling asynchronous and event-based values produced over time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this sentence (disclaimer, I am a bit noobish with rxjs). Observables can be used for that, but they are much more.

Would make sense to say ...

Observables are a programming technique that can be used for handling asynchronous and event-based values procuded over time

And even so, I am not so sure :/



**Observables** are a programming technique for handling asynchronous and event-based values produced over time.
The <a href="https://github.com/benlesh/RxJS" target="_blank" title="Reactive Extensions for Javascript (RxJS) library">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why a link to benlesh fork and not the real deal?


<div class="alert is-critical">

Its import to avoid incomplete operator imports. A common example is having multiple files that use Observable operators but not all files imports the operators they need. If you load the files with the necessary operators imported first and then load the other files, everything works fine. Conversely, loading the files without the imported operators first blows up because the operators aren't available on the Observable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand the first sentence.

<div>
<label>Name: </label>

<label>ID: </label> {{ (hero$ | async)?.name }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why a label for ID here?

@mary-poppins
Copy link

You can preview 7fa4b70 at https://pr16452-7fa4b70.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 84c07c9 at https://pr16452-84c07c9.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 9012622 at https://pr16452-9012622.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 0bb8174 at https://pr16452-0bb8174.ngbuilds.io/.

@mary-poppins
Copy link

You can preview a705287 at https://pr16452-a705287.ngbuilds.io/.

@brandonroberts brandonroberts force-pushed the rxjs-guide branch 2 times, most recently from 4c46d6c to a4a1f76 Compare September 5, 2017 02:22
@mary-poppins
Copy link

You can preview 4c46d6c at https://pr16452-4c46d6c.ngbuilds.io/.

@mary-poppins
Copy link

You can preview a4a1f76 at https://pr16452-a4a1f76.ngbuilds.io/.

@mary-poppins
Copy link

You can preview f840570 at https://pr16452-f840570.ngbuilds.io/.

@mary-poppins
Copy link

You can preview 7ab406e at https://pr16452-7ab406e.ngbuilds.io/.

@brandonroberts brandonroberts changed the title WIP docs(aio): Added developer guide on RxJS docs(aio): Added developer guide on RxJS Oct 21, 2017
@mary-poppins
Copy link

You can preview bd0bad4 at https://pr16452-bd0bad4.ngbuilds.io/.

@jenniferfell
Copy link
Contributor

@jasonaden : Recommendation here? Has all of this been incorporated into the new doc you're working on, so this can be closed? Other next steps on this PR? Thanks.

@jenniferfell
Copy link
Contributor

@jasonaden Can we close this as a duplicate of #21423 ?

@splincode
Copy link
Contributor

@brandonroberts what is the status of your pull request? is it still relevant? please fix conflicts if they exist

@brandonroberts
Copy link
Contributor Author

@splincode this guide has been folded into the Observables guide except for the marble testing area, which will come along later. I think this can be closed.

@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants