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

fix: always return promise if async #2728

Merged
merged 4 commits into from Mar 22, 2023
Merged

fix: always return promise if async #2728

merged 4 commits into from Mar 22, 2023

Conversation

UziTech
Copy link
Member

@UziTech UziTech commented Feb 4, 2023

Marked version: 4.2.12

Description

Always return a promise if async option is true.

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@vercel
Copy link

vercel bot commented Feb 4, 2023 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
marked-website ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 5, 2023 at 3:50PM (UTC)

@UziTech UziTech mentioned this pull request Feb 4, 2023
Closed
styfle
styfle reviewed Feb 4, 2023
View reviewed changes
src/marked.js
+ escape(e.message + '', true)
+ '</pre>';
if (opt.async) {
return Promise.reject(msg);
}
Copy link
Member

Choose a reason for hiding this comment

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

It’s unusual to reject with a string. Usually it’s an Error

Copy link
Member Author

Choose a reason for hiding this comment

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

This is in silent mode so maybe we should actually resolve with the string?

Copy link
Member Author

Choose a reason for hiding this comment

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

Currently the string is returned in silent mode instead of thrown

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated it to resolve on silent and reject with error when not in silent mode. This seems to be the closest async equivalent to what happens when synchronous.

styfle
styfle reviewed Feb 4, 2023
View reviewed changes
docs/USING_PRO.md Outdated Show resolved Hide resolved
@UziTech @styfle
docs: walktokens async
2915d5c 
Co-authored-by: Steven <steven@ceriously.com>
@UziTech UziTech mentioned this pull request Feb 11, 2023
Merged
5 tasks
styfle
styfle approved these changes Feb 15, 2023
View reviewed changes
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@UziTech UziTech merged commit 042dcc5 into markedjs:master Mar 22, 2023
github-actions bot pushed a commit that referenced this pull request Mar 22, 2023
@semantic-release-bot
chore(release): 4.3.0 [skip ci]
d65cf63 
# [4.3.0](v4.2.12...v4.3.0) (2023-03-22)

### Bug Fixes

* always return promise if async ([#2728](#2728)) ([042dcc5](042dcc5))
* fenced code doesn't need a trailing newline ([#2756](#2756)) ([3acbb7f](3acbb7f))

### Features

* add preprocess and postprocess hooks ([#2730](#2730)) ([9b452bc](9b452bc))
@UziTech UziTech deleted the fix-async branch August 26, 2023 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@styfle styfle styfle approved these changes

@calculuschild calculuschild Awaiting requested review from calculuschild

@davisjam davisjam Awaiting requested review from davisjam

@joshbruce joshbruce Awaiting requested review from joshbruce

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

async: true inconsistent return type (Promise | string) + docs update
2 participants
@UziTech @styfle