Gathering detailed insights and metrics for human-id
💃🆔 Generates human readable identifier strings by chaning common (short) words of the english language.
Installations
npm install human-idDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
19.4.0
NPM Version
9.2.0
Score
100
Supply Chain
100
Quality
75.8
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
7
Languages
2
TypeScript
JavaScript
TypeScript (92.43%)
JavaScript (7.57%)
Developer
RienNeVaPlus
Download Statistics
Total Downloads
76,029,890
Last Day
245,479
Last Week
1,141,178
Last Month
4,466,264
Last Year
42,888,701
GitHub Statistics
200 Stars
48 Commits
19 Forks
3 Watching
1 Branches
7 Contributors
Bundle Size
7.99 kB
Minified
3.21 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
4.1.1
Package Id
human-id@4.1.1
Unpacked Size
50.07 kB
Size
14.66 kB
File Count
16
NPM Version
9.2.0
Node Version
19.4.0
Publised On
02 Feb 2024
Total Downloads
Cumulative downloads
Total Downloads
76,029,890
Last day
17.5%
245,479
Compared to previous day
Last week
-0.9%
1,141,178
Compared to previous week
Last month
8.1%
4,466,264
Compared to previous month
Last year
109.6%
42,888,701
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
1
Versions
💃🆔
Human-Readable Identifiers
Using words to identify datasets (instead of numbers) provides various advantages when humans are involved, ie increased distinction and rememberability.
Human-ID generates readable strings by chaining common short words of the english language in a semi-meaningful way.
The result is concatenated of adjective + noun + verb resulting in a minimum pool size of 15 000 000 possible combinations.
- SFW: no bad words; family friendly results
- No dependencies
Examples
- FortyGhostsTalk
- CalmSnailsDream
- TastyRocksSparkle
- HealthyCowsSmile
- AfraidWallsExist
- StrangeCarsRush
- TwoLizardsSing
- HappyLionsJump
Install
Yarn
yarn add human-id
NPM
npm install human-id
Usage
Command line
1npx human-id 2# RareGeckosJam 3 4npx human-id lowercase + 2x 5# rare+geckos+jam 6# healthy+cows+smile
Programmatic
1import {humanId, poolSize, minLength, maxLength} from 'human-id' 2 3// RareGeckosJam 4humanId() 5 6// Rare~Geckos~Jam 7// alias for { separator: '~' } 8humanId('~') 9 10// rare-geckos-jam 11humanId({ 12 separator: '-', 13 capitalize: false, 14}) 15 16poolSize() // 15,000,000 17minLength() // 8 18maxLength() // 19
Extended Pool Size
For most cases, the default pool size should be large enough. However, the options adjectiveCount and addAdverb can be utilized to increase the pool size for the price of the string length.
1const options = { 2 adjectiveCount: 2, 3 addAdverb: true, 4 separator: '.' 5} 6 7humanId(options) // Ten.Wet.Files.Cheer.Lazily 8poolSize(options) // 630,000,000 9minLength(options) // 20 10maxLength(options) // 41
Executable arguments
Use the following arguments to modify the default options or print multiple results.
| Argument | Effect |
|---|---|
a, adverb, addAdverb | Sets option.addAdverb to true |
l, lower, lowercase | Sets option.capitalize to false |
space | Sets option.separator to an empty space |
| any number | Sets option.adjectiveCount to the given integer |
| any single character | Sets option.separator to the character |
any number followed by x | Repeats the output number times |
Example
1npx human-id adverb lower 2 _ 3x 2# clever_shaggy_memes_sit_quietly 3# cuddly_spicy_boxes_wave_politely 4# sweet_fair_wombats_fetch_bravely
API
humanId(options?: string | Option): string
Generates a human ID. Options can be a string (separator), a boolean (capitalize) or an Options object of:
- separator
string = ''- Separates the words from each other - capitalize
boolean = true- Whether to transform the first character of each word to upper case - adjectiveCount
number = 1- How many adjectives to return - addAdverb
boolean = false- Adds a fourth part to the id
This function is also available as the default export
poolSize(options?: string | Option): number
Returns the number of possible combinations for a given set of options.
minLength(options?: Option): number
The length of the shortest possible id for a given set of options.
maxLength(options?: Option): number
The length of the longest possible id for a given set of options.
adjectives: string[]
List of possible values for the first part of the human id.
nouns: string[]
List of possible values for the second part of the human id.
verbs: string[]
List of possible values for the third part of the human id.
adverbs: string[]
List of possible values for the optional fourth part of the human id.
💃🆔
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 5/20 approved changesets -- score normalized to 2
Reason
3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 15 are checked with a SAST tool
Score
3.6
/10
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More