https://github.com/stdlib-js/napi-argv-int64
Convert a Node-API value to a signed 64-bit integer.
https://github.com/stdlib-js/napi-argv-int64
addon int int64 javascript macros napi native node node-js nodejs stdlib utilities utils
Last synced: 3 months ago
JSON representation
Convert a Node-API value to a signed 64-bit integer.
- Host: GitHub
- URL: https://github.com/stdlib-js/napi-argv-int64
- Owner: stdlib-js
- License: apache-2.0
- Created: 2023-02-02T04:32:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T03:14:36.000Z (5 months ago)
- Last Synced: 2025-02-18T15:53:22.596Z (3 months ago)
- Topics: addon, int, int64, javascript, macros, napi, native, node, node-js, nodejs, stdlib, utilities, utils
- Language: C
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 192 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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_int64
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a Node-API value to a signed 64-bit integer.
## Installation
```bash
npm install @stdlib/napi-argv-int64
```
## Usage
```javascript
var headerDir = require( '@stdlib/napi-argv-int64' );
```
#### 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-int64' );
console.log( headerDir );
// =>
```
* * *
## C APIs
### Usage
```c
#include "stdlib/napi/argv_int64.h"
```
#### stdlib_napi_argv_int64( env, value, \*out, \*message, \*err )
Converts a Node-API value to a signed 64-bit integer.
```c
#include "stdlib/napi/argv_int64.h"
#include
#include
static napi_value addon( napi_env env, napi_callback_info info ) {
napi_value value;
// ...
int64_t out;
napi_value err;
napi_status status = stdlib_napi_argv_int64( 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] int64_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_int64( const napi_env env, const napi_value value, int64_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_INT64( env, name, argv, index )
Macro for converting an add-on callback argument to a signed 64-bit integer.
```c
#include "stdlib/napi/argv_int64.h"
#include "stdlib/napi/argv.h"
#include
#include
static int64_t fcn( const int64_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_INT64( env, value, argv, 0 );
// ...
int64_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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/napi-argv-int64.svg
[npm-url]: https://npmjs.org/package/@stdlib/napi-argv-int64
[test-image]: https://github.com/stdlib-js/napi-argv-int64/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/napi-argv-int64/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/napi-argv-int64/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/napi-argv-int64?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/napi-argv-int64/main/LICENSE