Return the data type enumeration constant of an ndarray data buffer.
npm install @stdlib/ndarray-base-buffer-dtype-enumWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return the data type enumeration constant of an ndarray data buffer.
``bash`
npm install @stdlib/ndarray-base-buffer-dtype-enum
`javascript`
var dtypeEnum = require( '@stdlib/ndarray-base-buffer-dtype-enum' );
#### dtypeEnum( buffer )
Returns the [data type][@stdlib/ndarray/dtypes] enumeration constant of an ndarray data [buffer][@stdlib/ndarray/base/buffer-ctors].
`javascript
var Float64Array = require( '@stdlib/array-float64' );
var buf = new Float64Array( 10 );
var c = dtypeEnum( buf );
// returns
`
If provided an ndarray data [buffer][@stdlib/ndarray/base/buffer-ctors] having an unknown or unsupported [data type][@stdlib/ndarray/dtypes], the function returns null.
`javascript`
var c = dtypeEnum( 'beep' );
// returns null
- The principle use case for this function is JavaScript-C interoperability. In C, dtypes are assigned integer enumeration constants, not string values.
`javascript
var dtypes = require( '@stdlib/ndarray-dtypes' );
var bufferCtors = require( '@stdlib/ndarray-base-buffer-ctors' );
var dtypeEnum = require( '@stdlib/ndarray-base-buffer-dtype-enum' );
// Get a list of supported ndarray buffer data types:
var DTYPES = dtypes( 'integer_and_generic' );
// Buffer length:
var len = 10;
// For each supported data type, create a buffer and retrieve its data type enumeration constant...
var ctor;
var i;
for ( i = 0; i < DTYPES.length; i++ ) {
ctor = bufferCtors( DTYPES[ i ] );
console.log( '%s => %d', DTYPES[ i ], dtypeEnum( new ctor( len ) ) );
}
// Try an array-like object...
var buf = {
'length': len
};
console.log( '%s => %s', 'generic', dtypeEnum( buf ) );
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-buffer-dtype-enum.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-buffer-dtype-enum
[test-image]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-buffer-dtype-enum/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-buffer-dtype-enum?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype-enum/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-buffer-dtype-enum/main/LICENSE
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray-dtypes
[@stdlib/ndarray/base/buffer-ctors]: https://www.npmjs.com/package/@stdlib/ndarray-base-buffer-ctors