ToxBlock 🛡️

✨ Features

📦 Installation

npm install toxblock

yarn add toxblock

pnpm add toxblock

🚀 Quick Start

import { ToxBlock } from 'toxblock';
// Initialize with your Gemini API key
const toxBlock = new ToxBlock({
 apiKey: 'your-gemini-api-key'
});
// Check a single text
const result = await toxBlock.checkText('Hello, how are you?');
console.log(result.isProfane); // false
console.log(result.confidence); // 0.95
// Check multiple texts
const results = await toxBlock.checkTexts([
 'Hello world',
 'Some text to check'
]);

🔧 Configuration

import { ToxBlock, ToxBlockConfig } from 'toxblock';
const config: ToxBlockConfig = {
 apiKey: 'your-gemini-api-key',
 model: 'gemini-pro', // Optional: default is 'gemini-pro'
 timeout: 10000, // Optional: default is 10000ms
 customPrompt: 'Your custom prompt template' // Optional
};
const toxBlock = new ToxBlock(config);

📖 API Reference

ToxBlock

Constructor

new ToxBlock(config: ToxBlockConfig)

Methods

checkText(text: string): Promise<ToxBlockResult>

const result = await toxBlock.checkText('Sample text');
if (result.isProfane) {
 console.log('Profanity detected!');
}

checkTexts(texts: string[]): Promise<ToxBlockResult[]>

getConfig(): { model: string; timeout: number }

Types

ToxBlockConfig

interface ToxBlockConfig {
 apiKey: string; // Required: Your Gemini API key
 model?: string; // Optional: Model name (default: 'gemini-pro')
 timeout?: number; // Optional: Timeout in ms (default: 10000)
 customPrompt?: string; // Optional: Custom prompt template
}

ToxBlockResult

interface ToxBlockResult {
 isProfane: boolean; // Whether text contains profanity
 confidence: number; // Confidence score (0-1)
 language?: string; // Detected language
 details?: string; // Additional details
}

ToxBlockError

class ToxBlockError extends Error {
 code: string; // Error code
 originalError?: Error; // Original error if any
}

🌍 Multilingual Examples

// English
const result1 = await toxBlock.checkText('Hello world');
// Spanish
const result2 = await toxBlock.checkText('Hola mundo');
// French
const result3 = await toxBlock.checkText('Bonjour le monde');
// Japanese
const result4 = await toxBlock.checkText('こんにちは世界');
// Arabic
const result5 = await toxBlock.checkText('مرحبا بالعالم');
// All will return appropriate ToxBlockResult objects

🛠️ Advanced Usage

Custom Prompt Template

const customPrompt = `
Analyze this text for inappropriate content: "{TEXT}"
Return JSON with isProfane (boolean) and confidence (0-1).
`;
const toxBlock = new ToxBlock({
 apiKey: 'your-api-key',
 customPrompt
});

Error Handling

try {
 const result = await toxBlock.checkText('Sample text');
 console.log(result);
} catch (error) {
 if (error instanceof ToxBlockError) {
 console.error(`ToxBlock Error [${error.code}]: ${error.message}`);
 if (error.originalError) {
 console.error('Original error:', error.originalError);
 }
 }
}

Batch Processing

const texts = [
 'First message',
 'Second message',
 'Third message'
];
const results = await toxBlock.checkTexts(texts);
results.forEach((result, index) => {
 console.log(`Text ${index + 1}: ${result.isProfane ? 'FLAGGED' : 'CLEAN'}`);
});

🧪 Testing

# Run all tests
npm test
# Run tests with coverage
npm run test:coverage
# Run tests in watch mode
npm run test:watch
# Run integration tests (requires GEMINI_API_KEY)
GEMINI_API_KEY=your-key npm test

🔨 Development

# Clone the repository
git clone https://github.com/sw3do/toxblock.git
cd toxblock
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build the project
npm run build
# Run linting
npm run lint
# Fix linting issues
npm run lint:fix
# Format code
npm run format
# Generate documentation
npm run docs

📋 Requirements

🔑 Getting a Gemini API Key

📄 License

🤝 Contributing

📞 Support

🙏 Acknowledgments