Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/napi-argv-uint32

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

https://github.com/stdlib-js/napi-argv-uint32

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords

addon javascript macros napi native node node-js nodejs stdlib uint uint32 utilities utils
Last synced: 4 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
addon javascript macros napi native node node-js nodejs stdlib uint uint32 utilities utils
Created almost 3 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

argv_uint32

NPM version Build Status Coverage Status <!-- dependencies -->

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

## Installation ```bash npm install @stdlib/napi-argv-uint32 ```
## Usage ```javascript var headerDir = require( '@stdlib/napi-argv-uint32' ); ``` #### headerDir Absolute file path for the directory containing header files for C APIs. ```javascript var dir = headerDir; // returns ```
## Examples ```javascript var headerDir = require( '@stdlib/napi-argv-uint32' ); console.log( headerDir ); // => ```
## C APIs
### Usage ```c #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. ```c #include "stdlib/napi/argv_uint32.h" #include #include 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`. ```c 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. ```c #include "stdlib/napi/argv_uint32.h" #include "stdlib/napi/argv.h" #include #include 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][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 6
Last Year
  • Push event: 6

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 19 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 4
npmjs.org: @stdlib/napi-argv-uint32

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

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 19 Last month
Rankings
Forks count: 15.9%
Stargazers count: 17.2%
Average: 31.0%
Dependent repos count: 37.3%
Dependent packages count: 53.5%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago