# bigmouth

> Library to get the info of the user almost how a fingerprint in tools for node and browser

Latest version **1.1.6** (published 2023-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install bigmouth
pnpm add bigmouth
yarn add bigmouth
bun add bigmouth
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2023-08-04 |
| First published | 2021-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Helton Silveira |
| Maintainers | heltonss |

## Links

- npm: https://www.npmjs.com/package/bigmouth
- Repository: https://github.com/heltonss/Big-Mouth
- Homepage: https://github.com/heltonss/Big-Mouth#readme
- Issues: https://github.com/heltonss/Big-Mouth/issues
- npm.io page: https://npm.io/package/bigmouth

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2

## Recent versions

- 1.1.6 (latest) — 2023-08-04
- 1.0.6 — 2021-12-23
- 1.0.5 — 2021-10-01
- 1.0.4 — 2021-10-01
- 1.0.3 — 2021-10-01
- 1.0.2 — 2021-10-01
- 1.0.1 — 2021-07-28
- 1.0.0 — 2021-07-28

## README

# Big Mouth

![test](https://github.com/heltonss/Big-Mouth/actions/workflows/test.yml/badge.svg)
![publish](https://github.com/heltonss/Big-Mouth/actions/workflows/publish.yml/badge.svg)

### Get a fingerprint of devices of yours users with informations how Browser, Shell, Memory, Language etc... for enviroments web and nodejs.

![one person tells a secret to another](big_mouth.svg)

## Table of contents

- [Install](#install)
- [Contributing](#contributing)
- [License](#license)

## Install

Install with [npm](https://www.npmjs.com/)

```sh
$ npm i bigmouth --save
```

## Introduction

Here is a brief of example what you can do

```ts
import { Browser, User, OperationSystem } from "bigmouth";

//with a object Browser.fingerprint you able get
Browser.fingerprint();
//  {
//    id: "0526d9cb-9e74-40d0-a2ca-d489ffad32fe"
//    browser: "chrome"
//    cookieEnabled: true
//    deviceMemory: 8
//    language: "pt-BR"
//    platform: "MacIntel"
//  }
```

Or you can get individually

```ts
Browser.platform();
// MacIntel
```

## The properties are disponibles, but User is OperatingSystem are more helpful in applications NodeJS

- Browser
  - getPlatform: string
  - getLanguage: string
  - getDeviceMemory: number | string
  - isCookieEnabled: boolean
  - getBrowser: string
  - getPositionUser: string
  - fingerprint: object
- User
  - username: string
  - shell: string
  - fingerprint: object
- OperationSystem
  - getNameOS: string
  - getReleaseOS: string
  - getQuantityMemory: number
  - getCpus: object[]
  - fingerprint: object

<br/>
<br/>

# Contributing

Confer our [guide](CONTRIBUTING) of contribution.
<br/>
<br/>

# License

By contributing, you agree that your contributions will be licensed under its [MIT License](License).

---
_Source: https://npm.io/package/bigmouth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._