Skip to content

fix(atlassian-connect-js): adjust context types to include promises #59632

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
typescript-bot merged 1 commit into from
Mar 31, 2022
Merged

fix(atlassian-connect-js): adjust context types to include promises #59632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions types/atlassian-connect-js/atlassian-connect-js-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ AP.confluence.syncPropertyFromServer('propertyKey', property => console.log(prop
AP.context.getToken(token => console.log(token)); // $ExpectType void
AP.context.getContext(context => console.log(context)); // $ExpectType void

AP.context.getToken(); // $ExpectType Promise<string>
AP.context.getContext(); // $ExpectType Promise<any>

AP.cookie.save('name', 'value', 10); // $ExpectType void
AP.cookie.read('name', value => console.log(value)); // $ExpectType void
AP.cookie.erase('name'); // $ExpectType void
Expand Down
2 changes: 2 additions & 0 deletions types/atlassian-connect-js/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,14 @@ declare namespace AP {
* @param callback the callback that handles the response
*/
function getToken(callback: (token: string) => void): void;
function getToken(): Promise<string>;

/**
* Retrieves the current user context containing details such as space key, issue id, etc.
* @param callback the callback that handles the response
*/
function getContext(callback: (context: any) => void): void;
function getContext(): Promise<any>;
}

/**
Expand Down