typescript-expert

// src/user-service.ts
export interface User {
    id: string;
    name: string;
    email: string;
    createdAt: Date;
}
 
export interface CreateUserInput {
    name: string;
    email: string;
}
 
type Result<T, E = Error> =
    | { success: true; data: T }
    | { success: false; error: E };
 
function isValidEmail(email: string): boolean {
    return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
}
 
export function createUser(input: CreateUserInput): Result<User> {
    if (!isValidEmail(input.email)) {
        return { success: false, error: new Error('Invalid email') };
    }
 
    const user: User = {
        id: crypto.randomUUID(),
        name: input.name,
        email: input.email,
        createdAt: new Date()
    };
 
    return { success: true, data: user };
}

// Refactor to use branded types for better type safety
type EmailAddress = string & { __brand: 'EmailAddress' };
type UserId = string & { __brand: 'UserId' };
 
export interface User {
    id: UserId;
    name: string;
    email: EmailAddress;
    createdAt: Date;
}
 
function validateEmail(email: string): EmailAddress | null {
    if (/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email)) {
        return email as EmailAddress;
    }
    return null;
}

# Type checking
npx tsc --noEmit
 
# Run tests with coverage
npx vitest run --coverage
 
# Lint checking
npx eslint src --ext .ts
 
# Build verification
npm run build

// ❌ UNSAFE: Not handling null/undefined
function getUser(id: string) {
    const user = users.find(u => u.id === id);
    return user.name; // Error if user is undefined!
}
 
// ✅ SAFE: Explicit null handling
function getUser(id: string): string | undefined {
    const user = users.find(u => u.id === id);
    return user?.name;
}
 
// ✅ BETTER: Type guard
function getUser(id: string): string {
    const user = users.find(u => u.id === id);
    if (!user) {
        throw new Error(`User ${id} not found`);
    }
    return user.name;
}
 
// ✅ BEST: Result type pattern
type Result<T, E = Error> =
    | { success: true; data: T }
    | { success: false; error: E };
 
function getUser(id: string): Result<User> {
    const user = users.find(u => u.id === id);
    if (!user) {
        return { success: false, error: new Error('User not found') };
    }
    return { success: true, data: user };
}

// ✅ Type-safe state management
type LoadingState<T> =
    | { status: 'idle' }
    | { status: 'loading' }
    | { status: 'success'; data: T }
    | { status: 'error'; error: Error };
 
function renderUser(state: LoadingState<User>) {
    switch (state.status) {
        case 'idle':
            return 'Click to load';
        case 'loading':
            return 'Loading...';
        case 'success':
            return state.data.name;
        case 'error':
            return state.error.message;
    }
}
 
// ✅ API response types
type ApiResponse<T> =
    | { kind: 'success'; data: T; timestamp: number }
    | { kind: 'error'; error: string; code: number }
    | { kind: 'redirect'; url: string };

// ✅ Constrained generics
interface Entity {
    id: string;
    createdAt: Date;
}
 
function findById<T extends Entity>(items: T[], id: string): T | undefined {
    return items.find(item => item.id === id);
}
 
// ✅ Multiple type parameters
function merge<T extends object, U extends object>(obj1: T, obj2: U): T & U {
    return { ...obj1, ...obj2 };
}
 
// ✅ Conditional types
type AsyncReturnType<T extends (...args: any) => any> =
    T extends (...args: any) => Promise<infer R> ? R : never;

// ✅ Type guard function
function isUser(value: unknown): value is User {
    return (
        typeof value === 'object' &&
        value !== null &&
        'id' in value &&
        'name' in value &&
        typeof (value as any).id === 'string'
    );
}
 
// ✅ Assertion function
function assertIsUser(value: unknown): asserts value is User {
    if (!isUser(value)) {
        throw new Error('Not a user');
    }
}
 
function handleUser(value: unknown) {
    assertIsUser(value);
    console.log(value.name); // TypeScript knows value is User
}

interface User {
    id: string;
    name: string;
    email: string;
    password: string;
}
 
// ✅ Partial - optional properties
type UserUpdate = Partial<User>;
 
// ✅ Pick - select properties
type UserPublic = Pick<User, 'id' | 'name' | 'email'>;
 
// ✅ Omit - exclude properties
type UserCreate = Omit<User, 'id'>;
 
// ✅ Record - object type
type UserRoles = Record<string, 'admin' | 'user'>;
 
// ✅ Readonly - immutable
type ImmutableUser = Readonly<User>;

// ✅ Nominal typing for type safety
type Brand<T, TBrand> = T & { __brand: TBrand };
 
type UserId = Brand<string, 'UserId'>;
type EmailAddress = Brand<string, 'EmailAddress'>;
 
function createUserId(id: string): UserId {
    return id as UserId;
}
 
function sendEmail(to: EmailAddress) {
    // Implementation
}
 
const userId = createUserId('123');
const email = 'user@example.com' as EmailAddress;
 
sendEmail(userId); // Error!
sendEmail(email); // OK

// ✅ Const assertion for literal types
const config = {
    apiUrl: 'https://api.example.com',
    timeout: 5000
} as const;
// Type: { readonly apiUrl: "https://api.example.com"; readonly timeout: 5000 }
 
// ✅ Enum alternative
const Colors = {
    RED: '#ff0000',
    GREEN: '#00ff00'
} as const;
 
type Color = typeof Colors[keyof typeof Colors];

// Bad: Redundant type annotations slow down IDE and compiler
const users: Array<User> = [];
const result: Result<User, Error> = getUser(id);
const handler: (event: MouseEvent) => void = (event: MouseEvent) => {
    console.log(event.target);
};
 
// Good: Let TypeScript infer types
const users: User[] = [];
const result = getUser(id);  // Type inferred from function return
const handler = (event: MouseEvent) => {
    console.log(event.target);
};
 
// Bad: Over-specifying generic parameters
function identity<T>(value: T): T {
    return value;
}
const num = identity<number>(42);
 
// Good: Let inference work
const num = identity(42);  // T inferred as number

// Bad: Complex nested conditionals computed on every use
type DeepReadonly<T> = T extends (infer U)[]
    ? DeepReadonlyArray<U>
    : T extends object
    ? DeepReadonlyObject<T>
    : T;
 
type DeepReadonlyArray<T> = ReadonlyArray<DeepReadonly<T>>;
type DeepReadonlyObject<T> = {
    readonly [P in keyof T]: DeepReadonly<T[P]>;
};
 
// Good: Use built-in utility types when possible
type SimpleReadonly<T> = Readonly<T>;
 
// Good: Cache complex type computations
type CachedDeepReadonly<T> = T extends object
    ? { readonly [K in keyof T]: CachedDeepReadonly<T[K]> }
    : T;
 
// Bad: Excessive type unions
type Status = 'a' | 'b' | 'c' | 'd' | 'e' | /* ... 100 more */;
 
// Good: Use string literal with validation
type Status = string & { __status: true };
function isValidStatus(s: string): s is Status {
    return ['active', 'pending', 'completed'].includes(s);
}

// Bad: No memoization for expensive computations
function expensiveTypeOperation<T extends object>(obj: T): ProcessedType<T> {
    // Called every render
    return processObject(obj);
}
 
// Good: Memoize with useMemo and proper typing
import { useMemo } from 'react';
 
function useProcessedData<T extends object>(obj: T): ProcessedType<T> {
    return useMemo(() => processObject(obj), [obj]);
}
 
// Bad: Creating new type guards on every call
function Component({ data }: Props) {
    const isValid = (item: unknown): item is ValidItem => {
        return validateItem(item);
    };
    return data.filter(isValid);
}
 
// Good: Define type guards outside component
function isValidItem(item: unknown): item is ValidItem {
    return validateItem(item);
}
 
function Component({ data }: Props) {
    return data.filter(isValidItem);
}
 
// Good: Memoize derived types with const assertions
const CONFIG = {
    modes: ['light', 'dark', 'system'] as const,
    themes: ['default', 'compact'] as const
};
 
type Mode = typeof CONFIG.modes[number];  // Computed once
type Theme = typeof CONFIG.themes[number];

// Bad: Barrel exports prevent tree-shaking
// index.ts
export * from './user';
export * from './product';
export * from './order';
// Imports entire module even if only using one type
 
// Good: Direct imports enable tree-shaking
import { User } from './models/user';
import { createUser } from './services/user-service';
 
// Bad: Class with many unused methods
class UserService {
    createUser() { }
    updateUser() { }
    deleteUser() { }
    // All methods bundled even if one used
}
 
// Good: Individual functions for tree-shaking
export function createUser() { }
export function updateUser() { }
export function deleteUser() { }
 
// Bad: Large type unions imported everywhere
import { AllEvents } from './events';
 
// Good: Import specific event types
import type { ClickEvent, KeyEvent } from './events/user-input';
 
// Good: Use `import type` for type-only imports
import type { User, Product } from './types';  // Stripped at compile time
import { createUser } from './services';       // Actual runtime import

// Bad: Eager loading of all types
import { HeavyComponent, HeavyProps } from './heavy-module';
 
// Good: Dynamic import with proper typing
const HeavyComponent = lazy(() => import('./heavy-module'));
type HeavyProps = React.ComponentProps<typeof HeavyComponent>;
 
// Bad: Importing entire library for one type
import { z } from 'zod';  // Entire zod library
 
// Good: Import only what you need
import { z } from 'zod/lib/types';  // If available
// Or use type-only import
import type { ZodSchema } from 'zod';

// tests/types.test.ts
import { expectTypeOf } from 'expect-type';
import type { User, CreateUserInput, Result } from '../src/types';
 
describe('Type definitions', () => {
    it('User should have correct shape', () => {
        expectTypeOf<User>().toHaveProperty('id');
        expectTypeOf<User>().toHaveProperty('email');
        expectTypeOf<User['id']>().toBeString();
    });
 
    it('Result type should be discriminated union', () => {
        type SuccessResult = Extract<Result<User>, { success: true }>;
        type ErrorResult = Extract<Result<User>, { success: false }>;
 
        expectTypeOf<SuccessResult>().toHaveProperty('data');
        expectTypeOf<ErrorResult>().toHaveProperty('error');
    });
});

// tests/user-service.test.ts
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { UserService } from '../src/user-service';
 
describe('UserService', () => {
    let service: UserService;
 
    beforeEach(() => {
        service = new UserService();
    });
 
    it('should create user with valid input', async () => {
        const input = { name: 'Test', email: 'test@example.com' };
        const result = await service.create(input);
 
        expect(result.success).toBe(true);
        if (result.success) {
            expect(result.data).toMatchObject({
                name: 'Test',
                email: 'test@example.com'
            });
        }
    });
 
    it('should handle errors gracefully', async () => {
        const result = await service.create({ name: '', email: '' });
 
        expect(result.success).toBe(false);
        if (!result.success) {
            expect(result.error).toBeDefined();
        }
    });
});

import { vi, type Mock } from 'vitest';
import type { ApiClient } from '../src/api-client';
 
// Type-safe mock
const mockApiClient: jest.Mocked<ApiClient> = {
    get: vi.fn(),
    post: vi.fn(),
    put: vi.fn(),
    delete: vi.fn()
};
 
// Typed mock return values
mockApiClient.get.mockResolvedValue({
    success: true,
    data: { id: '1', name: 'Test' }
});

// ❌ UNSAFE
const user = data as User;
 
// ✅ SAFE
if (isUser(data)) {
    const user = data;
}

{
    "compilerOptions": {
        "strictNullChecks": true
    }
}

// ❌ UNSAFE
function process(data) { }
 
// ✅ SAFE
function process(data: unknown) { }

// ❌ DON'T
function process(data: any) { }
 
// ✅ DO
function process(data: unknown) { }

// ❌ DON'T
{ "strict": false }
 
// ✅ DO
{ "strict": true }

// ❌ DON'T
const user = apiResponse as User;
 
// ✅ DO
const user = validateUser(apiResponse);

// ❌ DON'T
interface UserUpdate {
    id?: string;
    name?: string;
}
 
// ✅ DO
type UserUpdate = Partial<User>;