API Response Validator

A validator for handling API responses that can return different types of data based on the operation result.

Capabilities

Validate success responses

• A response with status "success" and data containing a user object (id: number, name: string) is validated successfully @test
• A response with status "success" but missing the data field is rejected with validation errors @test

Validate error responses

• A response with status "error" and an error object (code: string, message: string) is validated successfully @test
• A response with status "error" but missing the error field is rejected with validation errors @test

Validate loading responses

• A response with status "loading" and no additional fields is validated successfully @test
• A response with an unrecognized status value is rejected with validation errors @test

Implementation

@generates

API

/**
 * Validates an API response that can be in one of three states:
 * - Success: Contains user data
 * - Error: Contains error information
 * - Loading: Indicates operation in progress
 *
 * @param response - The API response object to validate
 * @returns Either an array of validation errors or the validated response
 */
export function validateResponse(response: unknown): any;

Dependencies { .dependencies }

io-ts { .dependency }

Provides runtime type validation with union type support.

@satisfied-by