stdlib-jsWe 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 Type
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Assert that a Node-API value is a specified Node-API data type.
bash
npm install @stdlib/assert-napi-is-type
javascript
var headerDir = require( '@stdlib/assert-napi-is-type' );
#### headerDir
Absolute file path for the directory containing header files for C APIs.
javascript
var dir = headerDir;
// returns <string>
javascript
var headerDir = require( '@stdlib/assert-napi-is-type' );
console.log( headerDir );
// => <string>
c
#include "stdlib/assert/napi/is_type.h"
#### stdlib_assert_napi_value_is_type( env, value, type, *message, *err )
Asserts that a Node-API value is a specified Node-API data type.
c
#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:
- env: [in] napi_env environment under which the function is invoked.
- value: [in] napi_value Node-API value.
- type: [in] napi_valuetype Node-API data type.
- message: [in] char* error message.
- err: [out] napi_value* pointer for storing a JavaScript error.
c
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.
