Skip to main content

Installation

Requirements​

  • Node.js >= 18

npm​

npm install @fazelstudio/username-intelligence

Manual / CDN​

The package ships as both ESM (.mjs) and CommonJS (.js) in the dist/ folder. You can copy the relevant file directly into your project.

Verify Installation​

Create a quick test file:

import { analyzeUsername } from '@fazelstudio/username-intelligence';

const result = analyzeUsername('test_user_123');
console.log('Analysis:', result.classification.style);

Run it:

node test.js

You should see output like Analysis: personal.

Package Contents​

When you install the package, you get:

node_modules/@fazelstudio/username-intelligence/
├── dist/
│   ├── index.js        # CommonJS bundle
│   ├── index.mjs       # ESM bundle
│   ├── index.d.ts      # TypeScript declarations (CJS)
│   └── index.d.mts     # TypeScript declarations (ESM)
├── README.md
├── CHANGELOG.md
├── LICENSE
└── package.json