Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@stdlib/assert-napi-is-type
Advanced tools
Assert that a Node-API value is a specified Node-API data type.
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!
Assert that a Node-API value is a specified Node-API data type.
npm install @stdlib/assert-napi-is-type
var headerDir = require( '@stdlib/assert-napi-is-type' );
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
// returns <string>
var headerDir = require( '@stdlib/assert-napi-is-type' );
console.log( headerDir );
// => <string>
#include "stdlib/assert/napi/is_type.h"
Asserts that a Node-API value is a specified Node-API data type.
#include "stdlib/assert/napi/is_type.h"
#include <node_api.h>
static napi_value addon( napi_env env, napi_callback_info info ) {
napi_value value;
// ...
napi_value err;
napi_status status = stdlib_assert_napi_value_is_type( env, value, napi_number, "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:
[in] napi_env
environment under which the function is invoked.[in] napi_value
Node-API value.[in] napi_valuetype
Node-API data type.[in] char*
error message.[out] napi_value*
pointer for storing a JavaScript error.napi_status stdlib_assert_napi_value_is_type( const napi_env env, const napi_value value, const napi_valuetype type, const char *message, napi_value *err );
The function returns a napi_status
status code indicating success or failure (returns napi_ok
if success).
value
whose type differs from type
, the function sets err
with a JavaScript error; otherwise, err
is set to NULL
.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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.
0.2.2 (2024-07-27)
<section class="commits">d04dcbd
- docs: remove private annotations in C comments (by Philipp Burckhardt)A total of 1 person contributed to this release. Thank you to this contributor:
FAQs
Assert that a Node-API value is a specified Node-API data type.
The npm package @stdlib/assert-napi-is-type receives a total of 1,497 weekly downloads. As such, @stdlib/assert-napi-is-type popularity was classified as popular.
We found that @stdlib/assert-napi-is-type demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.