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

doc: update napi_async_init documentation #33181

Closed
wants to merge 4 commits into from

Commits on Apr 30, 2020

  1. doc: update napi_async_init documentation

    Fixes: nodejs#33153
    
    Change documentation to make async_resource required
    as opposed to optional in napi-async_init.
    
    Changes over time mean this parameter is required for
    proper operation of async hooks (which are still experimental).
    This changes the documentation to document what
    callers should do. We are doing this only in the doc
    in order to avoid a breaking change in N-API. We could
    create a new version of the method for which the
    parametrer is enforced as mandatory but we should only
    do that once async hooks is no longer experimental. In
    that case we could deprecate (but not remove this version
    of the method).
    
    Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>
    mhdawson committed Apr 30, 2020
    Copy the full SHA
    a62c146 View commit details
    Browse the repository at this point in the history

Commits on May 4, 2020

  1. Update doc/api/n-api.md

    Co-authored-by: legendecas <legendecas@gmail.com>
    mhdawson and legendecas committed May 4, 2020
    Copy the full SHA
    218f110 View commit details
    Browse the repository at this point in the history
  2. Update doc/api/n-api.md

    mhdawson committed May 4, 2020
    Copy the full SHA
    9d5c4d4 View commit details
    Browse the repository at this point in the history
  3. Update doc/api/n-api.md

    mhdawson committed May 4, 2020
    Copy the full SHA
    ca52b00 View commit details
    Browse the repository at this point in the history