npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/napi-argv-uint32

v0.2.2

Published

Convert a Node-API value to an unsigned 32-bit integer.

Downloads

62

Readme

argv_uint32

NPM version Build Status Coverage Status

Convert a Node-API value to an unsigned 32-bit integer.

Installation

npm install @stdlib/napi-argv-uint32

Usage

var headerDir = require( '@stdlib/napi-argv-uint32' );

headerDir

Absolute file path for the directory containing header files for C APIs.

var dir = headerDir;
// returns <string>

Examples

var headerDir = require( '@stdlib/napi-argv-uint32' );

console.log( headerDir );
// => <string>

C APIs

Usage

#include "stdlib/napi/argv_uint32.h"

stdlib_napi_argv_uint32( env, value, *out, *message, *err )

Converts a Node-API value to an unsigned 32-bit integer.

#include "stdlib/napi/argv_uint32.h"
#include <node_api.h>
#include <stdint.h>

static napi_value addon( napi_env env, napi_callback_info info ) {
    napi_value value;

    // ...

    uint32_t out;
    napi_value err;
    napi_status status = stdlib_napi_argv_uint32( env, value, &out, "Must be a number.", &err );
    assert( status == napi_ok );
    if ( err != NULL ) {
        assert( napi_throw( env, err ) == napi_ok );
        return NULL;
    }

    // ...
}

The function accepts the following arguments:

  • env: [in] napi_env environment under which the function is invoked.
  • value: [in] napi_value Node-API value.
  • out: [out] uint32_t* destination for storing output value.
  • message: [in] char* error message.
  • err: [out] napi_value* pointer for storing a JavaScript error. If not provided a number, the function sets err with a JavaScript error; otherwise, err is set to NULL.
napi_status stdlib_napi_argv_uint32( const napi_env env, const napi_value value, uint32_t *out, const char *message, napi_value *err );

The function returns a napi_status status code indicating success or failure (returns napi_ok if success).

STDLIB_NAPI_ARGV_UINT32( env, name, argv, index )

Macro for converting an add-on callback argument to an unsigned 32-bit integer.

#include "stdlib/napi/argv_uint32.h"
#include "stdlib/napi/argv.h"
#include <node_api.h>
#include <stdint.h>

static uint32_t fcn( const uint32_t v ) {
    return v;
}

// ...

static napi_value addon( napi_env env, napi_callback_info info ) {
    // Retrieve add-on callback arguments:
    STDLIB_NAPI_ARGV( env, info, argv, argc, 1 );

    // Convert the first argument to a C type:
    STDLIB_NAPI_ARGV_UINT32( env, value, argv, 0 );

    // ...

    uint32_t out = fcn( value );
}

The macro expects the following arguments:

  • env: environment under which the callback is invoked.
  • name: output variable name.
  • argv: name of the variable containing add-on callback arguments.
  • index: argument index.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.