Skip to content

refactor: update getTokenOptions name and add missing import to docs #939

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

Merged
nikithauc merged 2 commits into from
Aug 29, 2022
Merged

refactor: update getTokenOptions name and add missing import to docs #939

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfa6c33
docs: add missing import
laudebugs Aug 29, 2022
d965bb7
refactor: GetTokenOptions type
laudebugs Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/TokenCredentialAuthenticationProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
// Import the TokenCredential class that you wish to use. This example uses a Client SecretCredential

import { ClientSecretCredential } from "@azure/identity";
import { Client } from "@microsoft/microsoft-graph-client";
import { TokenCredentialAuthenticationProvider, TokenCredentialAuthenticationProviderOptions } from "@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials";

// Create an instance of the TokenCredential class that is imported
Expand Down
4 changes: 2 additions & 2 deletions src/authentication/azureTokenCredentials/ITokenCredentialAuthenticationProviderOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import { AuthenticationProviderOptions } from "../../IAuthenticationProviderOpti
/**
* @interface
* A signature represents the Authentication provider options for Token Credentials
* @property {getTokenoptions} [GetTokenOptions] - Defines options for TokenCredential.getToken.
* @property {getTokenOptions} [GetTokenOptions] - Defines options for TokenCredential.getToken.
*/
export interface TokenCredentialAuthenticationProviderOptions extends AuthenticationProviderOptions {
getTokenoptions?: GetTokenOptions;
getTokenOptions?: GetTokenOptions;
}
2 changes: 1 addition & 1 deletion src/authentication/azureTokenCredentials/TokenCredentialAuthenticationProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export class TokenCredentialAuthenticationProvider implements AuthenticationProv
error.message = "Scopes cannot be empty, Please provide scopes";
throw error;
}
const response = await this.tokenCredential.getToken(scopes, this.authenticationProviderOptions.getTokenoptions);
const response = await this.tokenCredential.getToken(scopes, this.authenticationProviderOptions.getTokenOptions);
if (response) {
return response.token;
}
Expand Down
4 changes: 2 additions & 2 deletions test/node/authentication/TokenCredentialAuthenticationProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ describe("TokenCredentialAuthenticationProvider.ts", () => {
}

const authProviderOptions: TokenCredentialAuthenticationProviderOptions = {
getTokenoptions: null,
getTokenOptions: null,
scopes,
};
const accessToken: AccessToken = { token: "dummy_valid_token", expiresOnTimestamp: 1 };
Expand All @@ -43,7 +43,7 @@ describe("TokenCredentialAuthenticationProvider.ts", () => {
throw new Error("Method definition for getToken is not found");
}
const authProviderOptions: TokenCredentialAuthenticationProviderOptions = {
getTokenoptions: null,
getTokenOptions: null,
scopes,
};
const accessToken: AccessToken = undefined;
Expand Down