docs: clarify documentation about listening to progress events #28892

oBusk · 2019-02-21T16:46:54Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
angular.io application / infrastructure changes
Other... Please describe:

What is the current behavior?

Issue Number: #28886

What is the new behavior?

Added observe: 'events' to the example code as well as added small section mentioning that it is needed.

Does this PR introduce a breaking change?

Yes
No

Other information

Closes #28886

mary-poppins · 2019-02-22T13:50:51Z

You can preview 8bf66c1 at https://pr28892-8bf66c1.ngbuilds.io/.

brandonroberts · 2019-02-22T13:55:11Z

aio/content/examples/http/src/app/uploader/uploader.service.ts

Remove changes here and just add the note

But is not observe default value body? So that observe: 'events' is needed?

Unless I'm mistaken, providing an HttpRequest instance returns an observable of events by default.

https://github.com/angular/angular/blob/master/packages/common/http/src/client.ts#L497

Oh! I see. I was confused by different syntax of new HttpRequest() vs httpClient.request(). Will update.

Are these changes still needed then in context of the example?

brandonroberts · 2019-02-22T13:55:57Z

aio/content/guide/http.md

Add to the existing note instead of two notes right next to each other.

Add `observe: 'events'` to see all events, including the progress of transfers.

The text still needs to be updated

Oh sorry I missed that.

Since, as you pointed out, observing events is default when sending request with HttpRequest, is there some wording to clarify that observe: events is needed when using the HttpClient.request with config object syntax?

If using HttpClient.request('POST', '/url', config) syntax, add observe: 'events' to see all events, including the progress of transfers.

What about:

"When using the HttpClient#request() method with an HTTP verb, configure with observe: 'events' to see all events, including the progress of transfers."

mary-poppins · 2019-02-22T14:24:50Z

You can preview c39b69e at https://pr28892-c39b69e.ngbuilds.io/.

mary-poppins · 2019-02-22T15:36:10Z

You can preview c07dcc1 at https://pr28892-c07dcc1.ngbuilds.io/.

mary-poppins · 2019-02-22T15:39:27Z

You can preview d0a672b at https://pr28892-d0a672b.ngbuilds.io/.

brandonroberts · 2019-02-22T15:59:40Z

@oBusk will you rebase on master so the preview job can finish correctly? And also squash down to a single commit.

Thanks

mary-poppins · 2019-02-22T16:10:38Z

You can preview 8df1697 at https://pr28892-8df1697.ngbuilds.io/.

brandonroberts · 2019-02-22T16:43:51Z

Couple more changes.

Update text to "When using HttpClient#request() with an HTTP method, ..."
Remove (http) from the git commit message, so its just docs: clarify documentation about listening to progress events

mary-poppins · 2019-02-22T16:53:01Z

You can preview 5fb1e31 at https://pr28892-5fb1e31.ngbuilds.io/.

brandonroberts · 2019-02-22T18:17:37Z

Thanks @oBusk!

oBusk · 2019-02-22T18:18:54Z

@brandonroberts Thanks for the feedback! 👍 🎆

PR Close #28892

angular-automatic-lock-bot · 2019-09-14T17:53:16Z

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.}

googlebot added the cla: yes label Feb 21, 2019

benlesh added comp: docs labels Feb 21, 2019

ngbot bot added this to the needsTriage milestone Feb 21, 2019

oBusk marked this pull request as ready for review February 21, 2019 18:01

oBusk requested a review from a team February 21, 2019 18:01

brandonroberts added effort1: hours target: patch This PR is targeted for the next patch release risk: low state: community Someone from the Angular community is working on this issue or submitted this PR refactoring Issue that involves refactoring or code-cleanup labels Feb 22, 2019

ngbot bot modified the milestones: needsTriage, Backlog Feb 22, 2019

brandonroberts self-assigned this Feb 22, 2019

brandonroberts added the aio: preview label Feb 22, 2019

brandonroberts suggested changes Feb 22, 2019

View reviewed changes

brandonroberts added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Feb 22, 2019

brandonroberts changed the title ~~docs(http): clarify documentation about listening to progress events~~ docs: clarify documentation about listening to progress events Feb 22, 2019

docs: clarify documentation about listening to progress events

5fb1e31

brandonroberts approved these changes Feb 22, 2019

View reviewed changes

brandonroberts added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Feb 22, 2019

benlesh closed this in 6ccf743 Feb 22, 2019

benlesh pushed a commit that referenced this pull request Feb 22, 2019

docs: clarify documentation about listening to progress events (#28892)

587ca85

PR Close #28892

oBusk deleted the docs-checkprogress branch February 22, 2019 23:45

brandonroberts mentioned this pull request Feb 25, 2019

Docs: http reportProgress requires observe events #28886

Closed

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 14, 2019

docs: clarify documentation about listening to progress events #28892

docs: clarify documentation about listening to progress events #28892

Uh oh!

Conversation

oBusk commented Feb 21, 2019

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brandonroberts Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brandonroberts Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

brandonroberts commented Feb 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

brandonroberts commented Feb 22, 2019

Uh oh!

mary-poppins commented Feb 22, 2019

Uh oh!

brandonroberts commented Feb 22, 2019

Uh oh!

oBusk commented Feb 22, 2019

Uh oh!

angular-automatic-lock-bot bot commented Sep 14, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

brandonroberts Feb 22, 2019 •

edited

Loading

brandonroberts Feb 22, 2019 •

edited

Loading

brandonroberts commented Feb 22, 2019 •

edited

Loading