Data

Tools

Indexes

Applications

Experiments

Open Source Science

napi-argv-dataview

Convert a Node-API value corresponding to a DataView to an array of bytes (i.e., an unsigned 8-bit integer array).

https://github.com/stdlib-js/napi-argv-dataview

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Keywords

addon array arraybuffer bytes dataview javascript macros napi native node node-js nodejs stdlib utilities utils
Last synced: 6 months ago · JSON representation ·

Repository

Convert a Node-API value corresponding to a DataView to an array of bytes (i.e., an unsigned 8-bit integer array).

Basic Info
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
addon array arraybuffer bytes dataview javascript macros napi native node node-js nodejs stdlib utilities utils
Created 8 months ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

argv_dataview

NPM version Build Status Coverage Status <!-- dependencies -->

Convert a Node-API value corresponding to a DataView to an array of bytes (i.e., an unsigned 8-bit integer array).

## Installation ```bash npm install @stdlib/napi-argv-dataview ```
## Usage ```javascript var headerDir = require( '@stdlib/napi-argv-dataview' ); ``` #### 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-argv-dataview' ); console.log( headerDir ); // => ```
## C APIs
### Usage ```c #include "stdlib/napi/argv_dataview.h" ``` #### stdlib_napi_argv_dataview( env, value, \*\*data, \*length, \*message, \*err ) Converts a Node-API value corresponding to a DataView to an array of bytes (i.e., an unsigned 8-bit integer array). ```c #include "stdlib/napi/argv_dataview.h" #include #include static napi_value addon( napi_env env, napi_callback_info info ) { napi_value value; // ... uint8_t *X; int64_t len; napi_value err; napi_status status = stdlib_napi_argv_dataview( env, value, &X, &len, "Must be a DataView.", &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. - **data**: `[out] uint8_t**` pointer for returning a reference to the output array. - **length**: `[out] int64_t*` pointer for returning the number of array elements. - **message**: `[in] char*` error message. - **err**: `[out] napi_value*` pointer for storing a JavaScript error. If not provided a DataView, the function sets `err` with a JavaScript error; otherwise, `err` is set to `NULL`. ```c napi_status stdlib_napi_argv_dataview( const napi_env env, const napi_value value, uint8_t **data, int64_t *length, const char *message, napi_value *err ); ``` The function returns a `napi_status` status code indicating success or failure (returns `napi_ok` if success). #### STDLIB_NAPI_ARGV_DATAVIEW( env, X, len, argv, index ) Macro for converting an add-on callback argument corresponding to a DataView to an array of bytes (i.e., an unsigned 8-bit integer array). ```c #include "stdlib/napi/argv_dataview.h" #include "stdlib/napi/argv.h" #include #include static void fcn( const uint8_t *X, const int64_t xlen, uint8_t *Y, const int64_t ylen ) { int64_t len; int64_t i; if ( xlen > ylen ) { len = ylen; } else { len = xlen; } for ( i = 0; i < len; i++ ) { Y[ i ] = X[ i ]; } } // ... static napi_value addon( napi_env env, napi_callback_info info ) { // Retrieve add-on callback arguments: STDLIB_NAPI_ARGV( env, info, argv, argc, 2 ); // Convert the first argument to a C type: STDLIB_NAPI_ARGV_DATAVIEW( env, X, xlen, argv, 0 ); // Convert the second argument to a C type: STDLIB_NAPI_ARGV_DATAVIEW( env, Y, ylen, argv, 1 ); // ... fcn( X, xlen, Y, ylen ); } ``` The macro expects the following arguments: - **env**: environment under which the callback is invoked. - **X**: output variable name for the array. - **len**: output variable name for the array length. - **argv**: name of the variable containing add-on callback arguments. - **index**: argument index.

* * * ## 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].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Push event: 2
  • Create event: 1
Last Year
  • Push event: 2
  • Create event: 1

Dependencies

.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite
.github/workflows/examples.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/publish.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite
.github/workflows/test.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_coverage.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
  • codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
  • distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite
.github/workflows/test_install.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
.github/workflows/test_published_package.yml actions
  • 8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
  • actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
  • actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
package.json npm
  • @stdlib/array-dataview ^0.2.2 development
  • @stdlib/array-typed ^0.3.0 development
  • @stdlib/array-uint8 ^0.2.2 development
  • @stdlib/assert-is-browser ^0.2.2 development
  • @stdlib/utils-try-require ^0.2.2 development
  • istanbul ^0.4.1 development
  • tap-min git+https://github.com/Planeshifter/tap-min.git development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-napi-is-dataview github:stdlib-js/assert-napi-is-dataview#main
  • @stdlib/assert-napi-status-ok ^0.2.2
  • @stdlib/napi-argv ^0.2.2
  • @stdlib/utils-library-manifest ^0.2.2