https://github.com/bytebodger/is-a-regular-object
Utility function for identifying regular JavaScript objects
https://github.com/bytebodger/is-a-regular-object
Last synced: 11 months ago
JSON representation
Utility function for identifying regular JavaScript objects
- Host: GitHub
- URL: https://github.com/bytebodger/is-a-regular-object
- Owner: bytebodger
- License: mit
- Created: 2021-02-22T21:41:59.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-02-24T17:09:42.000Z (over 5 years ago)
- Last Synced: 2025-05-19T00:17:31.264Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@toolz/is-a-regular-object
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# is-a-regular-object
`is-a-regular-object` is a tiny, dead-simple utility function for identifying regular JavaScript objects. In JavaScript, a `NULL` will show a `typeof` "object". An array will also show a `typeof` "object". This function returns `TRUE` for non-`NULL`, non-array objects - and it returns `FALSE` for everything else.
**NOTE:** This package is for "vanilla" JS. As such, it will identify React elements as being "regular" objects. If you're working in a React project, you should consider using `@toolz/is-a-regular-object-react`.
## Usage
After installation, import the package:
```javascript
import { isARegularObject } from '@toolz/is-a-regular-object';
```
### isARegularObject()
```javascript
const API = {
arguments: {
value: {
required,
format: any,
},
},
returns: Boolean,
}
```
```javascript
isARegularObject({}); // true
isARegularObject({one: 'uno', two: 'dos'}); // true
isARegularObject({numbers: [1, 2, 3], letters: ['a', 'b', 'c']}); // true
isARegularObject(null); // false
isARegularObject([]); // false
isARegularObject([1, 2, 3]); // false
isARegularObject(''); // false
isARegularObject('object'); // false
isARegularObject(() => console.log('foo')); // false
```