https://github.com/stdlib-js/napi-create-double
Convert a double-precision floating-point number to a Node-API value.
https://github.com/stdlib-js/napi-create-double
addon double float64 javascript macros napi native node node-js nodejs stdlib utilities utils
Last synced: 9 months ago
JSON representation
Convert a double-precision floating-point number to a Node-API value.
- Host: GitHub
- URL: https://github.com/stdlib-js/napi-create-double
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-04-18T00:48:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T01:16:33.000Z (10 months ago)
- Last Synced: 2025-04-12T17:54:22.245Z (9 months ago)
- Topics: addon, double, float64, javascript, macros, napi, native, node, node-js, nodejs, stdlib, utilities, utils
- Language: Python
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 86.9 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!
# create_double
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Convert a double-precision floating-point number to a Node-API value.
## Installation
```bash
npm install @stdlib/napi-create-double
```
## Usage
```javascript
var headerDir = require( '@stdlib/napi-create-double' );
```
#### 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-create-double' );
console.log( headerDir );
// =>
```
* * *
## C APIs
### Usage
```c
#include "stdlib/napi/create_double.h"
```
#### stdlib_napi_create_double( env, value, \*out )
Converts a double-precision floating-point number to a Node-API value.
```c
#include "stdlib/napi/create_double.h"
#include
static napi_value addon( napi_env env, napi_callback_info info ) {
// ...
napi_value value;
napi_status status = stdlib_napi_create_double( env, 1.0, &value );
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] double` double-precision floating-point number.
- **out**: `[out] napi_value*` destination for storing output value.
```c
napi_status stdlib_napi_create_double( const napi_env env, const double value, napi_value *out );
```
The function returns a `napi_status` status code indicating success or failure (returns `napi_ok` if success).
#### STDLIB_NAPI_CREATE_DOUBLE( env, expression, name )
Macro for converting a double-precision floating-point number to a Node-API value.
```c
#include "stdlib/napi/create_double.h"
#include "stdlib/napi/argv_double.h"
#include "stdlib/napi/argv.h"
#include
static double fcn( const double 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_DOUBLE( env, value, argv, 0 );
// ...
// Convert a value having a C type to a Node-API value:
STDLIB_NAPI_CREATE_DOUBLE( env, fcn( value ), out );
return out;
}
```
The macro expects the following arguments:
- **env**: environment under which the callback is invoked.
- **expression**: expression returning a double-precision floating-point number.
- **name**: output variable name.
* * *
## 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].
[npm-image]: http://img.shields.io/npm/v/@stdlib/napi-create-double.svg
[npm-url]: https://npmjs.org/package/@stdlib/napi-create-double
[test-image]: https://github.com/stdlib-js/napi-create-double/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/napi-create-double/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/napi-create-double/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/napi-create-double?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-create-double/main/LICENSE