# rough-name

> An utility to get a rough name of html element

Latest version **1.0.0** (published 2017-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install rough-name
pnpm add rough-name
yarn add rough-name
bun add rough-name
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-05-01 |
| First published | 2017-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Koji Takami |
| Maintainers | vzg03566 |
| Keywords | dom, element, nodeName, id, className |

## Links

- npm: https://www.npmjs.com/package/rough-name
- npm.io page: https://npm.io/package/rough-name

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-05-01

## README

rough-name
==========

DESCRIPTION
-----------

An utility to get a rough name of html element.

The name is configured by its tagName, id and className as possible.
This is available for logging or debugging, but not for identify
the element in a document.

PREPARATION
-----------

```html
<script src="rough-name.js"></script>
<script>
    function main() {
        console.log(RoughName.get(document.getElementById());
    }
</script>
```

If the `require` is available, 

```javascript
var RoughName = require('rough-name');

console.log(roughName.get(document.getElementById());
```


APIs
----

`RoughName.get(element)`
------------------------

### SYNTAX

```javascript
roughName.get(<element>)
```

### PARAMETER

* element - HTML element.

### RETURNS

The rough name of the element.

LICENSE
-------

This software is released under the MIT License, see [LICENSE](LICENSE)

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