# automatic-name

> automatic username for chinese and english

Latest version **1.1.7** (published 2022-02-12) · ISC license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.7 |
| Published | 2022-02-12 |
| First published | 2021-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 43.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | WayneChu |
| Maintainers | waynechu |
| Keywords | automatic-name, auto-name, user-name, username, nickname, randomname |

## Links

- npm: https://www.npmjs.com/package/automatic-name
- Repository: https://github.com/Onetail/automatic-name
- Issues: https://github.com/Onetail/automatic-name/issues
- npm.io page: https://npm.io/package/automatic-name

## Dependencies (1)

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

## Recent versions

- 1.1.7 (latest) — 2022-02-12
- 1.1.6 — 2022-02-12
- 1.1.5 — 2022-02-12
- 1.1.4 — 2021-03-15
- 1.1.3 — 2021-03-10
- 1.1.2 — 2021-03-10
- 1.1.1 — 2021-03-10
- 1.1.0 — 2021-03-10
- 1.0.1 — 2021-03-09
- 1.0.0 — 2021-03-09

## README

# automatic-name

## How to install

``` yarn add automatic-name ```

or 

``` npm install automatic-name ``` 

## Feature
#### Create new name 
```createNewName(language1, language2 ...) ```

language arguments
* taiwan
* chinese
* english

> It will be selected a random language without any arguments.

![](https://i.imgur.com/m1TwiE0.png)


#### Get firstname and lastname middle spacing 
``` getSpacing() ```
  
#### Set firstname and lastname middle spacing 
``` setSpacing(string) ``` 

#### Get tag string 
``` getTag() ```
  
#### Set tag string 
``` setTag(string) ``` 


#### Get username
``` getUsername() ```
    
#### Get fullname
``` getFullName(option) ```

option argument
* option [color=#2a1377](mean: 'spacing', type: 'string')


#### Get username with Tag
``` getUsernameWithTag(type [,options]) ```
#### Get fullname with Tag
``` getFullnameWithTag(type [,options]) ```
type argument
* type [color=#2a1fff](mean: 'random type', type: 'string')
    * number (mean: 'random number')
    * timestamp (mean: 'Date.now()')
    * v* (mean: 'uuid extension for uuid library: [uuid](https://www.npmjs.com/package/uuid)')

params arguments
* if type = number, params argument 1 is random count
    ![](https://i.imgur.com/KoDokNe.png)

    > default 4
* uuid extension arguments


![](https://i.imgur.com/V2fpjR3.png)


## Example


```
const AutomaticName = require('automatic-name');

const name = new AutomaticName();

(async () => {
  name.getUsername();
  // RobertsHolly

  name.getFullname();
  // Roberts Holly

  await name.getUsernameWithTag('v1');
  // RobertsHolly#c39404b1-8170-11eb-9eea-774c26920ecf

  name.createNewName();
  // random a new name
})();

```

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