Skip to content

Latest commit

 

History

History
24 lines (13 loc) · 1.16 KB

File metadata and controls

24 lines (13 loc) · 1.16 KB

StruLink Documentation

Welcome to the official documentation for StruLink, a comprehensive TypeScript library for URL/URI encoding, decoding, validation, and security analysis.

This documentation is modularized to help you find the exact information you need.

Table of Contents

1. Main API Reference

2. Security & Sanitization

  • Safety Layer (__safeEncode__) - Documentation on context-aware encoding for various environments (HTML, JavaScript, SQL, commands, etc.).
  • Pattern Detection Types - Detailed information on MaliciousPatternType, MaliciousPatternResult, DetectedPattern, and the predefined PATTERNS dictionary.

3. Utility Functions

  • Utilities - Simple exported utilities like decodeB64 and detectDuplicateUrlParams.

This documentation is structured to provide professional, precise, and highly detailed guides for enterprise integrators and security engineers.