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!
Equal Types
Assert that two Node-API data types are equal.
Installation
npm install @stdlib/assert-napi-equal-types
Usage
var headerDir = require( '@stdlib/assert-napi-equal-types' );
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
Examples
var headerDir = require( '@stdlib/assert-napi-equal-types' );
console.log( headerDir );
C APIs
Usage
#include "stdlib/assert/napi/equal_types.h"
stdlib_assert_napi_equal_types( env, type1, type2, *message, *err )
Asserts that two Node-API data types are equal.
#include <node_api.h>
static napi_value addon( napi_env env, napi_callback_info info ) {
napi_valuetype vtype1;
napi_valuetype vtype2;
napi_value err;
napi_status status = stdlib_assert_napi_equal_types( env, vtype1, vtype2, "Must have equal types.", &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. - type1:
[in] napi_valuetype
first data type. - type2:
[in] napi_valuetype
second data type. - message:
[in] char*
error message. - err:
[out] napi_value*
pointer for storing a JavaScript error.
napi_status stdlib_assert_napi_equal_types( const napi_env env, const napi_valuetype type1, const napi_valuetype type2, const char *message, napi_value *err );
The function returns a napi_status
status code indicating success or failure (returns napi_ok
if success).
Notes
- If provided unequal data types, the function sets
err
with a JavaScript error; otherwise, err
is set to NULL
.
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.
![Chat](https://img.shields.io/gitter/room/stdlib-js/stdlib.svg)
License
See LICENSE.
Copyright
Copyright © 2016-2023. The Stdlib Authors.
0.1.0 (2023-09-23)
<section class="features">
Features
5200ce2
- update minimum TypeScript version
</section>
<!-- /.features -->
<section class="breaking-changes">
BREAKING CHANGES
</section>
<!-- /.breaking-changes -->
<section class="commits">
Commits
<details>
5200ce2
- feat: update minimum TypeScript version (by Philipp Burckhardt)
</details>
</section>
<!-- /.commits -->
<section class="contributors">
Contributors
A total of 1 person contributed to this release. Thank you to this contributor:
</section>
<!-- /.contributors -->
</section>
<!-- /.release -->
<section class="release" id="v0.0.1">