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.

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

Migrate to Typescript #22

Merged
merged 23 commits into from
Mar 25, 2020
Merged

Migrate to Typescript #22

merged 23 commits into from
Mar 25, 2020

Conversation

dhleong
Copy link
Owner

@dhleong dhleong commented Mar 2, 2020

This PR represents a heavy refactor, migrating all existing functionality in a mostly API-compatible way to Typescript. Auth handling in particular has been cleaned up, simplified, and even slightly improved in some cases. At the very least, it's much easier to follow and maintain, now.

As part of the Typescript rewrite, core PepperMint method arguments now have strong types so it's easier to get things right, and their return types are also strongly-typed, making it easier to explore the API.

Breaking Changes

The only breaking change is that we no longer use Q for promises, and instead use native promises. This should only be a problem if you used the deprecated .fail() method instead of the standard .catch()

The PepperMint.sessionCookies property no longer exists. If you really want access to the cookies, you can use PepperMint.auth.cookies, but per notes in the README it is probably not worth saving these cookies due to a short lifetime.

Deprecations

The getRefreshingAccountIds() method is now deprecated. You should prefer getRefreshingProviderIds() instead, which does the exact same thing, but its name actually matches what it returns. getRefreshingAccountIds() may be removed in a future release.

@dhleong dhleong merged commit 9d5aabd into master Mar 25, 2020
@dhleong dhleong deleted the dhleong/typescript branch March 25, 2020 22:02
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant