@stdlib/napi-argv

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

C utilities for retrieving Node-API add-on callback arguments.

Installation

npm install @stdlib/napi-argv

Usage

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

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' );

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

---

C APIs

Usage

#include "stdlib/napi/argv.h"

STDLIB_NAPI_ARGV( env, info, argv, argc, nargs )

Macro for retrieving add-on callback arguments.

#include <node_api.h>

// ...

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

    // ...
}

The macro expects the following arguments:

• env: environment under which the callback is invoked.
• info: callback data.
• argv: variable name for storing argument values.
• argc: variable name for storing the number of provided arguments.
• nargs: expected number of arguments.

If the number of provided arguments does not equal the expected number of arguments, the macro's generated code raises an exception.

STDLIB_NAPI_ARGV_INDEX2ORDINAL( index )

Macro for converting an index to an ordinal numeral.

STDLIB_NAPI_ARGV_INDEX2ORDINAL( 2 )

The macro expects the following arguments:

• index: argument index value.

The first few ordinal numerals are as follows:

• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 0 ): "First".
• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 1 ): "Second".
• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 2 ): "Third".
• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 3 ): "Fourth".
• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 4 ): "Fifth".
• ...
• STDLIB_NAPI_ARGV_INDEX2ORDINAL( 29 ): "Thirtieth".

This macro can be useful when generating error messages which state which argument is invalid (e.g., "invalid argument. First argument must be a number." ).

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.0 (2024-02-14)

<section class="commits">

Commits

<details>

• 46d049b - build: replace tslint directive (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.1.1">