Skip to content

doc: napi_create_range_error has incorrect prototype #20623

Closed
Closed
doc: napi_create_range_error has incorrect prototype#20623
Labels
docIssues and PRs related to Node.js documentation.node-apiIssues and PRs related to Node-API.

Description

@primeare
primeare
opened on May 9, 2018

Function napi_create_range_error in documentation has prototype:

NODE_EXTERN napi_status napi_create_range_error(napi_env env,
                                                napi_value code,
                                                const char* msg,
                                                napi_value* result);

where msg has type const char*. But according to node_api.h the prototype should be:

NAPI_EXTERN napi_status napi_create_range_error(napi_env env,
                                                napi_value code,
                                                napi_value msg,
                                                napi_value* result);

with msg having type napi_value.

Activity

  1. TimothyGu
    added
    docIssues and PRs related to Node.js documentation.
    node-apiIssues and PRs related to Node-API.
    on May 9, 2018

  2. mhdawson commented on May 9, 2018

    @mhdawson
    mhdawson
    on May 9, 2018
    Member

    Fixing.

  3. mhdawson
    added a commit that references this issue on May 9, 2018

    doc: fix signature for napi_create_range_error

    0a091fb

  4. mhdawson commented on May 9, 2018

    @mhdawson
    mhdawson
    on May 9, 2018
    Member

    PR with fix, #20641

  5. mhdawson commented on May 9, 2018

    @mhdawson
    mhdawson
    on May 9, 2018
    Member

    @primeare thanks for reporting, I also fixed NODE_EXTERN->NAPI_EXTERN throughout the doc

  6. shobhitchittora commented on May 12, 2018

    @shobhitchittora
    shobhitchittora
    on May 12, 2018
    Contributor

    @mhdawson if fixed, can this issue be closed ? Thanks.

  7. addaleax
    closed this as completedin 7dcfe72on May 14, 2018
  8. addaleax
    added a commit that references this issue on May 14, 2018

    doc: fix signature for napi_create_range_error

    f263340
  9. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: fix signature for napi_create_range_error

    7dcfe72
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.node-apiIssues and PRs related to Node-API.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions