Huk JS

HuK (Helper Utility Kit)

Package: @vorlaxen-labs/huk-js v1.1.2 · Zero runtime deps · Tree-shakeable

Nine focused utility namespaces replacing scattered utils/ folders with a single, type-safe API.

Critical Rules

1. Prefer named module imports for backends: import { string, object } from '@vorlaxen-labs/huk-js'.
2. Use sub-path imports for smallest bundle: import { string } from '@vorlaxen-labs/huk-js/string'.
3. Use HuK.is.* type guards before treating unknown values as typed — never loose typeof checks.
4. HuK is not a validation framework — use Zod/Yup for schema validation; HuK for lightweight checks.
5. Never reimplement utilities HuK already provides — check reference/api-reference.md first.

Import Strategies

// 1. Namespace (scripts, prototypes)
import { HuK } from '@vorlaxen-labs/huk-js';
HuK.string.slugify('Merhaba Dünya!');

// 2. Named modules (recommended for backends)
import { string, object, number } from '@vorlaxen-labs/huk-js';
string.slugify('Hello World');
object.get(user, 'profile.name', 'Anonymous');

// 3. Sub-path (smallest bundle)
import { string } from '@vorlaxen-labs/huk-js/string';

Module Overview

Quick Examples

import { string, object, number, HuK } from '@vorlaxen-labs/huk-js';

// Turkish-aware slugify
string.slugify('Merhaba Dünya!');  // 'merhaba-dunya'

// PII masking
string.mask('4444555566667777', { visibleEnd: 4 });

// Input validation
string.isEmail(email);
string.isStrongPassword(password);

// Safe nested access
const page = object.get(req.query, 'page', 1);
const search = object.get(req.query, 'search');

// Type-safe query parsing
const searchQuery = object.get(req.query, 'search');
const searchTerm =
  HuK.is.string(searchQuery) && searchQuery.trim().length > 0
    ? searchQuery.trim()
    : undefined;

// Number formatting
number.currency(1234.5, { currency: 'TRY', locale: 'tr-TR' });
number.clamp(value, 0, 100);

// Array grouping
array.groupBy(orders, o => o.status);

// Async helpers
await fn.retry(() => fetchData(), 3, 1000);
const debouncedSearch = fn.debounce(search, 300);

Sub-Path Imports

HuK + BaR Pattern

import { object, string } from '@vorlaxen-labs/huk-js';

app.get('/api/users', async (req, res) => {
  const search = object.get(req.query, 'search', '');
  const sanitized = string.isEmpty(search) ? undefined : search.trim();
  const users = await userService.search(sanitized);
  return res.builder.as.ok(users).build();
});

When NOT to Use HuK

• Full schema validation → Zod, Yup, class-validator
• Timezone-aware dates → date-fns, Luxon, Temporal
• Entire lodash surface area → HuK is intentionally focused

Reference Documentation