Socket
Socket
Sign inDemoInstall

mnemonic-id

Package Overview
Dependencies
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mnemonic-id - npm Package Compare versions

Comparing version 3.2.1 to 3.2.3

2

package.json
{
"name": "mnemonic-id",
"description": "Library to generate easy to remember, and sometimes entertaining, human readable ids",
"version": "3.2.1",
"version": "3.2.3",
"license": "MIT",

@@ -6,0 +6,0 @@ "author": "Mattias E. O. Andersson",

@@ -7,3 +7,3 @@ # Mnemonic id

Library to generate easy to remember, and sometimes entertaining, human readable ids.
```js
```ts
createStoryId(); // -> awesome-chipmunk-banish-evil-rat

@@ -31,11 +31,11 @@ ```

Import in either way that suits your environment:
```js
```ts
import { createNameId } from 'mnemonic-id';
createNameId();
```
```js
```ts
import * as mnemonicId from 'mnemonic-id';
mnemonicId.createNameId();
```
```js
```ts
const mnemonicId = require('mnemonic-id');

@@ -47,3 +47,3 @@ mnemonicId.createNameId();

```js
```ts
/** Format "noun", ≈ 10^2 permutations, 10 max length */

@@ -78,3 +78,3 @@ createNounId(); // -> narwhal

Or customize your own:
```js
```ts
createCustomId({

@@ -94,3 +94,3 @@ adjectives: 2,

```js
```ts
createNameId({

@@ -107,28 +107,22 @@ adjectives: 3,

```ts
interface IdOpts {
/** Number of adjectives given to object/subject */
adjectives?: number;
/** Creates subject in id sentence */
subject?: boolean;
/** Creates verb in id sentence */
verb?: boolean;
/** Creates object in id sentence */
object?: boolean;
/** Creates number of given length at end of id sentence */
/** Creates id of given length at end of id sentence */
idSuffix?: number;
/** Delimiter to be used in id sentence */
delimiter?: string;
/** Capitalize each word in sentence */
capitalize?: boolean;
}
```
/** Number of adjectives given to object/subject */
adjectives?: number;
/** Creates subject in id sentence */
subject?: boolean;
/** Creates verb in id sentence */
verb?: boolean;
/** Creates object in id sentence */
object?: boolean;
/** Creates number of given length at end of id sentence */
numberSuffix?: number;
/** Creates id of given length at end of id sentence */
idSuffix?: number;
/** Delimiter to be used in id sentence */
delimiter?: string;
/** Capitalize each word in sentence */
capitalize?: boolean;
```
# Alternatives

@@ -135,0 +129,0 @@

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc