Skip to content
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.

Sign up for GitHub

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

Jump to bottom

In the CommonDeviceCodeRequest type, add unit to the timeout property description #3016

Closed
2 of 13 tasks
waldekmastykarz opened this issue Feb 12, 2021 · 1 comment
Closed
2 of 13 tasks

In the CommonDeviceCodeRequest type, add unit to the timeout property description #3016

waldekmastykarz opened this issue Feb 12, 2021 · 1 comment
Assignees
@hectormmg
Labels
documentation Related to documentation. msal-common Related to msal-common package question Customer is asking for a clarification, use case or information.

Comments

@waldekmastykarz
Copy link

Library

  • msal@1.x.x or @azure/msal@1.x.x
  • @azure/msal-browser@2.x.x
  • @azure/msal-node@1.x.x
  • @azure/msal-react@1.x.x
  • @azure/msal-angular@0.x.x
  • @azure/msal-angular@1.x.x
  • @azure/msal-angular@2.x.x
  • @azure/msal-angularjs@1.x.x

Documentation location

  • docs.microsoft.com
  • MSAL.js Github Wiki
  • README file
  • Other (code comment)
  • Documentation does not exist

Description

In the code comment of the CommonDeviceCodeRequest type, specify the unit for the timeout property in its description. Right now, it's impossible to decide what value should be specified because it's not clear if the value is ms, s or something else.

microsoft-authentication-library-for-js/lib/msal-common/src/request/CommonDeviceCodeRequest.ts

Line 18 in a58a549

* - timeout - Period in which the user explicitly configures for the polling of the device code endpoint. At the end of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period.

@waldekmastykarz waldekmastykarz added documentation Related to documentation. question Customer is asking for a clarification, use case or information. labels Feb 12, 2021
@hectormmg hectormmg self-assigned this Feb 16, 2021
@pkanher617 pkanher617 added the msal-common Related to msal-common package label Feb 16, 2021
@hectormmg hectormmg mentioned this issue Feb 16, 2021
Merged
@hectormmg
Copy link
Member

Closing since this was addressed in #3031.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@hectormmg hectormmg

Labels
documentation Related to documentation. msal-common Related to msal-common package question Customer is asking for a clarification, use case or information.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hectormmg @pkanher617 @waldekmastykarz