Skip to content

Update Typescript Docs#1711

Merged
ajimae merged 1 commit intomasterfrom
chore/update-typescript-docs
Sep 20, 2021
Merged

Update Typescript Docs#1711
ajimae merged 1 commit intomasterfrom
chore/update-typescript-docs

Conversation

@ajimae
Copy link
Copy Markdown
Member

@ajimae ajimae commented Sep 16, 2021

Tasks:

  • add more details and explanation to the timeout and backoff properties
  • add more details and explanation to the retryConfig objects and all it's properties including:
  • maxRetries
  • backoff
  • maxDelay
  • retryDelay

Summary

Add more details explanation

Description

This PR includes more detailed explanation of some of the most used http middleware object properties.

Todo

  • Tests
    • Unit
    • Integration
    • Acceptance
  • Documentation
  • Type label for the PR

- add more details and explanation to the timeout and backoff properties
- add more details and explanation to the retryConfig objects and all it's properties including:
- maxRetries
- backoff
- maxDelay
- retryDelay
@ajimae ajimae requested review from jenschude and jherey September 16, 2021 04:39
@ajimae ajimae self-assigned this Sep 16, 2021
@codecov
Copy link
Copy Markdown

codecov bot commented Sep 16, 2021

Codecov Report

Merging #1711 (8570ea9) into master (a7df4f3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1711   +/-   ##
=======================================
  Coverage   98.65%   98.65%           
=======================================
  Files         128      128           
  Lines        3428     3428           
  Branches      791      791           
=======================================
  Hits         3382     3382           
  Misses         42       42           
  Partials        4        4           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a7df4f3...8570ea9. Read the comment docs.

@ashishhk ashishhk requested a review from a team September 16, 2021 08:48
Copy link
Copy Markdown
Contributor

@jherey jherey left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for updating the documentation.

@ajimae ajimae merged commit 9034675 into master Sep 20, 2021
@ajimae ajimae deleted the chore/update-typescript-docs branch September 20, 2021 14:39
ajimae added a commit that referenced this pull request Oct 26, 2021
- add more details and explanation to the timeout and backoff properties
- add more details and explanation to the retryConfig objects and all it's properties including:
- maxRetries
- backoff
- maxDelay
- retryDelay
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants