@stdlib/assert-napi-is-typedarray
v0.2.2
Published
Assert that a Node-API value is a Node-API typed array.
Downloads
8,295
Readme
Assert Typed Array
Assert that a Node-API value is a typed array.
Installation
npm install @stdlib/assert-napi-is-typedarray
Usage
var headerDir = require( '@stdlib/assert-napi-is-typedarray' );
headerDir
Absolute file path for the directory containing header files for C APIs.
var dir = headerDir;
// returns <string>
Examples
var headerDir = require( '@stdlib/assert-napi-is-typedarray' );
console.log( headerDir );
// => <string>
C APIs
Usage
#include "stdlib/assert/napi/is_typedarray.h"
stdlib_assert_napi_value_is_typedarray( env, value, *message, *err )
Asserts that a Node-API value is a typed array.
#include "stdlib/assert/napi/is_typedarray.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_typedarray( env, value, "Must be a typed array.", &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. - message:
[in] char*
error message. - err:
[out] napi_value*
pointer for storing a JavaScript error.
napi_status stdlib_assert_napi_value_is_typedarray( const napi_env env, const napi_value value, 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 not provided a typed array, the function sets
err
with a JavaScript error; otherwise,err
is set toNULL
.
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.