npmpackage.info

nid

Nice clean-mouthed unique id generation, without any swearing!

2.0.1

MIT

JavaScript

887.00 B

4,975,926 2.5

Installations

npm install nid

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Min. Node Version

>=12

Node Version

16.14.2

NPM Version

8.5.0 Score

87.4

Supply Chain

100

Quality

75.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

13

Closed

9

Merged

3

Issues

Open

0

Total

3

Closed

3

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 4 contributors

Languages

JavaScript

TypeScript

HTML

JavaScript (60.36%)

TypeScript (38.39%)

HTML (1.25%)

Developer

rjrodger

Download Statistics

Total Downloads

4,975,926

Last Day

1,470

Last Week

8,344

Last Month

37,717

Last Year

698,640

GitHub Statistics

33 Stars

41 Commits

6 Forks

6 Watching

2 Branches

4 Contributors

Bundle Size

1.63 kB

Minified

887.00 B

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.1

Package Id

nid@2.0.1

Unpacked Size

20.40 kB

Size

6.98 kB

File Count

NPM Version

8.5.0

Node Version

16.14.2

Total Downloads

Cumulative downloads

Total Downloads

4,975,926

Last day

-40.7%

1,470

Compared to previous day

Last week

-30.1%

8,344

Compared to previous week

Last month

-13.3%

37,717

Compared to previous month

Last year

-23.2%

698,640

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/jest browserify esbuild esbuild-jest jest tinyify ts-jest typescript

Versions

nid

Nice clean-mouthed random id generation, without any swearing!

A Node.js module that generates random identifiers for public consumption. Swear words not included.

	This open source module is sponsored and supported by Voxgig.

What it Does

This module is useful for custom short links, password generation and any sort of unique tag an end user might see.

By default the big seven curse words are avoided (thanks @dshaw!). The Battlestar Galactica version of one of the big seven is also avoided.

NOTE: this module is not cryptographically secure and should only be used in low-risk environments.

Quick example

1var nid = require('nid')
2
3// generate a 6 character alphanumberic id, like: ytnzt2
4console.log( nid() )
5
6// generate a 3 character alphanumberic id, like: 5rg
7console.log( nid(3) )
8

Install

1npm install nid

Length

You can change the length of the identifier string by passing an integer to nid, as per the quick example above. The default alphanumeric alphabet is used.

Options

You can change the ids generated by passing an options object to the nid function. A new, custom, function is returned. For example:

1var mynid = require('nid')({length:8})
2
3// generate an 8 character alphanumberic id, like: qnzvetvp
4console.log( mynid() )

You have the following options:

length: number of characters in the id string
alphabet: a string containing the set of characters in the id, e.g. 1234567890abcdef
curses: specify the list of curse words to avoid (you can use exclude as an alias if you don't want to sound quaint)

You can specify the curses as:

an array of strings: ["gosh","darn"]
a CSV formatted string: "gosh, darn"
a regular expression: matches are excluded
a function: first arg is the proposed id, return true to exclude

As a convenience you can use the following alphabet shortcuts:

hex: alphabet is '0123456789abcdef'
HEX: alphabet is '0123456789ABCDEF'

Examples:

1var nid = require('nid')
2
3var nid_ABC = nid({alphabet:'ABC'})
4console.log(nid_ABC()) // prints something like BCCABB
5
6var nid_hex = nid({hex:1})
7console.log(nid_hex()) // prints something like 47b5df
8
9var nid_noa = nid({curses:/a/})
10console.log(nid_noa()) // never includes an 'a' character

How it Works

Keep getting a random character from a given alphabet of characters, until you have enough to meet the length requirement. Then check if it contains a curse word (case-insensitive). If so, try again.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2025-01-27

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

Other packages similar to nid

nv-facutil-nid

1.0.6

eg-nid

1.1.0

Extract basic info from Egyptian NIDs

nid-parser

0.0.5

NID (Native Interface Definition) is a portable C/C++ API description format that parses into JSON format for convenient bindings generation

vue-cli-plugin-nid

1.2.10

这是[宁皓网](https://ninghao.net)内部项目使用的一个 Vue CLI 插件，在使用了 TypeScript 的 Vue 项目里，可以用命令生成应用需要的组件与 Store 模块。