# @sapphire/type
**A type detection utility for JavaScript.**
[](https://github.com/sapphire-project/utilities/blob/main/LICENSE.md)
[](https://lgtm.com/projects/g/sapphire-project/utilities/alerts/)
[](https://lgtm.com/projects/g/sapphire-project/utilities/context:javascript)
[](https://coveralls.io/github/sapphire-project/utilities?branch=main)
[](https://bundlephobia.com/result?p=@sapphire/type)
[](https://www.npmjs.com/package/@sapphire/type)
[](https://depfu.com/github/sapphire-project/utilities?project_id=15195)
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Basic Usage](#basic-usage)
- [API Documentation](#api-documentation)
- [Buy us some doughnuts](#buy-us-some-doughnuts)
- [Contributors β¨](#contributors-%E2%9C%A8)
## Description
Sometimes there is a need to know what a value's type of something is, this package exists to satisfy those needs by implementing a parser that can retrieve the type of the value recursively and process a string similar to TypeScript's types.
## Features
- Written in TypeScript
- Bundled with Rollup so it can be used in NodeJS and browsers
- Offers CommonJS, ESM and UMD bundles
- Fully tested
## Installation
```sh
yarn add @sapphire/type
# npm install @sapphire/type
```
## Usage
**Note:** While this section uses `require`, the imports match 1:1 with ESM imports. For example `const { Type } = require('@sapphire/type')` equals `import { Type } from '@sapphire/type'`.
### Basic Usage
```ts
// Import the Type class
const { Type } = require('@sapphire/type');
// Define a Type with an array of two numbers
const type = new Type([1, 2]);
console.log(type.toString());
// Logs: Array
```
---
## API Documentation
For the full API documentation please refer to the TypeDoc generated [documentation](https://sapphire-project.github.io/utilities/modules/_sapphire_type.html).
## Buy us some doughnuts
Sapphire Project is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
| Donate With | Address |
| :-------------: | :----------------------------------------------------------------------------------------------: |
| Open Collective | [Click Here](https://opencollective.com/sapphire-project) |
| Ko-fi | [Click Here](https://ko-fi.com/sapphireproject) |
| Patreon | [Click Here](https://www.patreon.com/sapphire_project) |
| PayPal | [Click Here](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SP738BQTQQYZY) |
## Contributors β¨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
