API Overview

TypeScript API Pro provides a rich set of type utilities organized into four main modules:

📦 Module Structure

typescript-api-pro/
├── object/     # Object type utilities
├── array/      # Array type utilities
├── map/        # Map type utilities
├── set/        # Set type utilities
└── string/     # String type utilities

🔧 Core Types

Basic Types

• PropertyKey - Object property key type
• AnyObject<T> - Generic object type

Object Operations

• ValueOf<T> - Extract object value types
• KeyOf<T> - Extract object key types
• Generic<R, K, T> - Override object property type
• OmitByObject<T, U> - Exclude properties based on object structure

Dependency Relationships

• RequiredDependency<T, K, D> - Property dependency relationship
• MutuallyWithObject<T> - Mutually exclusive object properties
• Mutually<T, K, O> - Two-property mutual exclusion

Array Operations

• ArrayItem<T> - Extract array element type

Map Operations

• MapKeyOf<T> - Extract Map key type
• MapValueOf<T> - Extract Map value type
• MapToObject<T> - Convert Map to object
• ObjectToMap<T> - Convert object to Map
• OmitMapKey<T, K> - Exclude Map keys
• PickMapKey<T, K> - Select Map keys

Set Operations

• SetValueOf<T> - Extract Set element type
• OmitSetValue<T, V> - Exclude Set values
• PickSetValue<T, V> - Select Set values
• ArrayToSet<T> - Convert array to Set
• SetToArray<T> - Convert Set to array

String Operations

• Camel2SnakeCase<T, U> - Convert camelCase to snake_case

🎯 Use Cases

Type-Safe Configuration Objects

import type { MutuallyWithObject, RequiredDependency } from 'typescript-api-pro';

interface DatabaseConfig {
  host?: string;
  port?: number;
  ssl?: boolean;
}

// Ensure host and port exist together or not at all
type SafeDatabaseConfig = RequiredDependency<DatabaseConfig, 'host', 'port'>;

Mutually Exclusive Options

import type { MutuallyWithObject } from 'typescript-api-pro';

interface AuthOptions {
  token: string;
  username: string;
  apiKey: string;
}

// Only one authentication method can be selected
type AuthMethod = MutuallyWithObject<AuthOptions>;

Collection Type Conversion

import type { ArrayToSet, MapToObject, SetToArray } from 'typescript-api-pro';

// Array to Set (automatic deduplication)
type UniqueColors = ArrayToSet<['red', 'blue', 'red', 'green']>; // Set<'red' | 'blue' | 'green'>

// Map to object
type ConfigObject = MapToObject<Map<'host' | 'port', string>>; // { host: string; port: string; }

String Transformation

import type { Camel2SnakeCase } from 'typescript-api-pro';

// Convert camelCase to UPPER_SNAKE_CASE
type SnakeCaseKey = Camel2SnakeCase<'userName'>; // 'USER_NAME'

// Convert to lowercase snake_case
type LowerSnakeCase = Camel2SnakeCase<'userId', false>; // 'user_id'

📖 Learn More

Choose a specific type category to learn more details and usage examples:

• Object Type Utilities
• Array Type Utilities
• Map Type Utilities
• Set Type Utilities
• String Type Utilities