https://github.com/hugoalh/is-primitive-es
An ECMAScript module to determine whether the item is a primitive.
https://github.com/hugoalh/is-primitive-es
ecmascript ecmascript-module es es-module esm esmodule is javascript js primitive ts typescript
Last synced: 5 months ago
JSON representation
An ECMAScript module to determine whether the item is a primitive.
- Host: GitHub
- URL: https://github.com/hugoalh/is-primitive-es
- Owner: hugoalh
- License: other
- Created: 2024-03-08T09:45:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-15T13:25:45.000Z (6 months ago)
- Last Synced: 2026-01-12T00:21:44.453Z (5 months ago)
- Topics: ecmascript, ecmascript-module, es, es-module, esm, esmodule, is, javascript, js, primitive, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 155 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Is Primitive (ES)
[**⚖️** MIT](./LICENSE.md)
[](https://github.com/hugoalh/is-primitive-es)
[](https://jsr.io/@hugoalh/is-primitive)
[](https://www.npmjs.com/package/@hugoalh/is-primitive)
An ECMAScript module to determine whether the item is a primitive.
## 🎯 Targets
| **Runtime \\ Source** | **GitHub Raw** | **JSR** | **NPM** |
|:--|:-:|:-:|:-:|
| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ✔️ | ✔️ |
| **[Deno](https://deno.land/)** >= v2.1.0 | ✔️ | ✔️ | ✔️ |
| **[NodeJS](https://nodejs.org/)** >= v20.9.0 | ❌ | ✔️ | ✔️ |
## 🛡️ Runtime Permissions
This does not request any runtime permission.
## #️⃣ Sources
- GitHub Raw
```
https://raw.githubusercontent.com/hugoalh/is-primitive-es/{Tag}/mod.ts
```
- JSR
```
jsr:@hugoalh/is-primitive[@{Tag}]
```
- NPM
```
npm:@hugoalh/is-primitive[@{Tag}]
```
> [!NOTE]
> - It is recommended to include tag for immutability.
> - These are not part of the public APIs hence should not be used:
> - Benchmark/Test file (e.g.: `example.bench.ts`, `example.test.ts`).
> - Entrypoint name or path include any underscore prefix (e.g.: `_example.ts`, `foo/_example.ts`).
> - Identifier/Namespace/Symbol include any underscore prefix (e.g.: `_example`, `Foo._example`).
## ⤵️ Entrypoints
| **Name** | **Path** | **Description** |
|:--|:--|:--|
| `.` | `./mod.ts` | Default. |
## 🧩 APIs
- ```ts
function isPrimitive(item: unknown): item is Primitive;
```
- ```ts
type Primitive = bigint | boolean | number | string | symbol | null | undefined;
```
> [!NOTE]
> - For the full or prettier documentation, can visit via:
> - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/doc/)
> - [JSR](https://jsr.io/@hugoalh/is-primitive)
## ✍️ Examples
- ```ts
isPrimitive({});
//=> false
```
- ```ts
isPrimitive(new Headers());
//=> false
```
- ```ts
isPrimitive(true);
//=> true
```
- ```ts
isPrimitive(123n);
//=> true
```