@stdlib/strided/base/dtype-enum2str/docs/types/index.d.ts

Strided.

/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* Returns the data type string associated with a strided array data type enumeration constant.
*
* @param dtype - data type enumeration constant
* @returns data type string
*
* @example
* var str2enum = require( '@stdlib/strided/base/dtype-str2enum' );
*
* var v = str2enum( 'float64' );
* // returns <number>
*
* var dt = enum2str( v );
* // returns 'float64'
*/
declare function enum2str( dtype: number ): string | null;


// EXPORTS //

export = enum2str;