Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/utils-constructor-name
Determine the name of a value's constructor.
https://github.com/stdlib-js/utils-constructor-name
check class constructor ctor instanceof is istype javascript name node node-js nodejs stdlib type typeof util utilities utility utils
Last synced: about 1 month ago
JSON representation
Determine the name of a value's constructor.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-constructor-name
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:24:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T02:31:04.000Z (3 months ago)
- Last Synced: 2024-09-29T15:01:28.198Z (about 2 months ago)
- Topics: check, class, constructor, ctor, instanceof, is, istype, javascript, name, node, node-js, nodejs, stdlib, type, typeof, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 549 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# Constructor Name
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Determine the name of a value's constructor.
## Installation
```bash
npm install @stdlib/utils-constructor-name
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var constructorName = require( '@stdlib/utils-constructor-name' );
```
#### constructorName( value )
Returns the name of a value's constructor.
```javascript
var v = constructorName( 'a' );
// returns 'String'
v = constructorName( 5 );
// returns 'Number'
function Beep() {
return this;
}
v = constructorName( new Beep() );
// returns 'Beep'
```
| description | value | constructor | notes |
| --------------------- | ----------------------------------- | --------------------- | ------------ |
| string | `'beep'` | `'String'` | |
| number | `5` | `'Number'` | |
| NaN | `NaN` | `'Number'` | |
| infinity | `+infinity`/`-infinity` | `'Number'` | |
| boolean | `true`/`false` | `'Boolean'` | |
| null | `null` | `'Null'` | |
| undefined | `undefined` | `'Undefined'` | |
| array | `['beep', 5]` | `'Array'` | |
| object | `{'foo': 'bar'}` | `'Object'` | |
| function | `function (){}` | `'Function'` | |
| symbol | `Symbol()` | `'Symbol'` | ES2015 |
| regexp | `/./` | `'RegExp'` | Android 4.1+ |
| String | `new String('beep')` | `'String'` | |
| Number | `new Number(5)` | `'Number'` | |
| Boolean | `new Boolean(false)` | `'Boolean'` | |
| Object | `new Object()` | `'Object'` | |
| Array | `new Array()` | `'Array'` | |
| Int8Array | `new Int8Array()` | `'Int8Array'` | |
| Uint8Array | `new Uint8Array()` | `'Uint8Array'` | |
| Uint8ClampedArray | `new Uint8ClampedArray()` | `'Uint8ClampedArray'` | |
| Int16Array | `new Int16Array()` | `'Int16Array'` | |
| Uint16Array | `new Uint16Array()` | `'Uint16Array'` | |
| Int32Array | `new Int32Array()` | `'Int32Array'` | |
| Uint32Array | `new Uint32Array()` | `'Uint32Array'` | |
| Float32Array | `new Float32Array()` | `'Float32Array'` | |
| Float64Array | `new Float64Array()` | `'Float64Array'` | |
| ArrayBuffer | `new ArrayBuffer()` | `'ArrayBuffer'` | |
| Buffer | `new Buffer()` | `'Buffer'` | Node.js |
| Date | `new Date()` | `'Date'` | |
| RegExp | `new RegExp('.')` | `'RegExp'` | Android 4.1+ |
| Function | `new Function('x', 'return x')` | `'Function'` | |
| Map | `new Map()` | `'Map'` | ES2015 |
| WeakMap | `new WeakMap()` | `'WeakMap'` | ES2015 |
| Set | `new Set()` | `'Set'` | ES2015 |
| WeakSet | `new WeakSet()` | `'WeakSet'` | ES2015 |
| Error | `new Error()` | `'Error'` | |
| TypeError | `new TypeError()` | `'TypeError'` | |
| SyntaxError | `new SyntaxError()` | `'SyntaxError'` | |
| ReferenceError | `new ReferenceError()` | `'ReferenceError'` | |
| URIError | `new URIError()` | `'URIError'` | |
| RangeError | `new RangeError()` | `'RangeError'` | |
| EvalError | `new EvalError()` | `'EvalError'` | |
| Math | `Math` | `'Math'` | |
| JSON | `JSON` | `'JSON'` | IE8+ |
| arguments | `(function(){return arguments;})()` | `'Arguments'` | IE9+ |
| custom constructor | `new Beep()` | `'Beep'` | |
| anonymous constructor | `new (function(){})()` | `''` | |
## Notes
- If a value's constructor is an anonymous `function`, the implementation returns an empty `string`.
```javascript
var Beep = function () {
return this;
};
var v = constructorName( new Beep() );
// returns ''
```
## Examples
```javascript
var Float32Array = require( '@stdlib/array-float32' );
var Float64Array = require( '@stdlib/array-float64' );
var Int8Array = require( '@stdlib/array-int8' );
var Int16Array = require( '@stdlib/array-int16' );
var Int32Array = require( '@stdlib/array-int32' );
var Uint8Array = require( '@stdlib/array-uint8' );
var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
var Uint16Array = require( '@stdlib/array-uint16' );
var Uint32Array = require( '@stdlib/array-uint32' );
var ArrayBuffer = require( '@stdlib/array-buffer' );
var Buffer = require( '@stdlib/buffer-ctor' );
var Symbol = require( '@stdlib/symbol-ctor' );
var constructorName = require( '@stdlib/utils-constructor-name' );
function noop() {
// Do nothing...
}
var v = constructorName( 'a' );
// returns 'String'
v = constructorName( 5 );
// returns 'Number'
v = constructorName( NaN );
// returns 'Number'
v = constructorName( null );
// returns 'Null'
v = constructorName( void 0 );
// returns 'Undefined'
v = constructorName( true );
// returns 'Boolean'
v = constructorName( false );
// returns 'Boolean'
v = constructorName( {} );
// returns 'Object'
v = constructorName( [] );
// returns 'Array'
v = constructorName( noop );
// returns 'Function'
v = constructorName( /./ );
// returns 'RegExp'
v = constructorName( new Date() );
// returns 'Date'
v = constructorName( new Map() );
// returns 'Map'
v = constructorName( new WeakMap() );
// returns 'WeakMap'
v = constructorName( new Set() );
// returns 'Set'
v = constructorName( new WeakSet() );
// returns 'WeakSet'
v = constructorName( Symbol( 'beep' ) );
// returns 'Symbol'
v = constructorName( new Error() );
// returns 'Error'
v = constructorName( new TypeError() );
// returns 'TypeError'
v = constructorName( new SyntaxError() );
// returns 'SyntaxError'
v = constructorName( new URIError() );
// returns 'URIError'
v = constructorName( new RangeError() );
// returns 'RangeError'
v = constructorName( new ReferenceError() );
// returns 'ReferenceError'
v = constructorName( new EvalError() );
// returns 'EvalError'
v = constructorName( new Int8Array() );
// returns 'Int8Array'
v = constructorName( new Uint8Array() );
// returns 'Uint8Array'
v = constructorName( new Uint8ClampedArray() );
// returns 'Uint8ClampedArray'
v = constructorName( new Int16Array() );
// returns 'Int16Array'
v = constructorName( new Uint16Array() );
// returns 'Uint16Array'
v = constructorName( new Int32Array() );
// returns 'Int32Array'
v = constructorName( new Uint32Array() );
// returns 'Uint32Array'
v = constructorName( new Float32Array() );
// returns 'Float32Array'
v = constructorName( new Float64Array() );
// returns 'Float64Array'
v = constructorName( new ArrayBuffer() );
// returns 'ArrayBuffer'
v = constructorName( new Buffer( 'beep' ) );
// returns 'Buffer'
v = constructorName( Math );
// returns 'Math'
v = constructorName( JSON );
// returns 'JSON'
function Person1() {
return this;
}
v = constructorName( new Person1() );
// returns 'Person1'
var Person2 = function () {
return this;
};
v = constructorName( new Person2() );
// returns ''
```
* * *
## See Also
- [`@stdlib/utils-function-name`][@stdlib/utils/function-name]: determine a function's name.
* * *
## 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-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-constructor-name.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-constructor-name
[test-image]: https://github.com/stdlib-js/utils-constructor-name/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-constructor-name/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-constructor-name/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-constructor-name?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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/utils-constructor-name/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-constructor-name/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-constructor-name/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-constructor-name/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-constructor-name/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-constructor-name/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-constructor-name/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-constructor-name/main/LICENSE
[@stdlib/utils/function-name]: https://github.com/stdlib-js/utils-function-name