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

add docs for workers #1432

Merged
merged 12 commits into from May 3, 2019
Merged

add docs for workers #1432

merged 12 commits into from May 3, 2019

Conversation

@UziTech
Copy link
Member

@UziTech UziTech commented Mar 1, 2019

Description

Add examples of how to run marked in a worker on node and in a browser.
https://docs-4nj255ohp.now.sh/#/USING_ADVANCED.md#workers

fixes #1184

Contributor

  • no tests required for this PR.

Committer

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

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR
docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
@styfle
Copy link
Member

@styfle styfle commented Mar 2, 2019

There was one bug in the example that was mixing function keyword and arrow functions.

I think we should just use arrow functions for workers because its an advanced feature and so we can assume the reader understands ES6.

styfle and others added 3 commits Mar 2, 2019
Co-Authored-By: UziTech <tony@brix.ninja>
Co-Authored-By: UziTech <tony@brix.ninja>
Co-Authored-By: UziTech <tony@brix.ninja>
styfle
styfle approved these changes Mar 2, 2019
Copy link
Member

@styfle styfle left a comment

💚

@UziTech
Copy link
Member Author

@UziTech UziTech commented Mar 2, 2019

Nice catch

@UziTech UziTech changed the title add docs for workers [WIP] add docs for workers Mar 7, 2019
@UziTech
Copy link
Member Author

@UziTech UziTech commented Mar 7, 2019

wait to merge this until after worker_threads in node are stable

@UziTech UziTech changed the title [WIP] add docs for workers add docs for workers Apr 26, 2019
@UziTech
Copy link
Member Author

@UziTech UziTech commented Apr 26, 2019

I added notes about Worker Threads being experimental and Web Workers sending objects on postMessage instead of just the string.

https://docs-4nj255ohp.now.sh/#/USING_ADVANCED.md#workers

I think this should be good to merge.

docs/USING_ADVANCED.md Outdated Show resolved Hide resolved
Co-Authored-By: UziTech <tony@brix.ninja>
styfle
styfle approved these changes Apr 27, 2019
@UziTech UziTech requested review from davisjam and joshbruce May 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

3 participants