Generating TypeScript Delete Controllers

TypeScript
import { genRequestInstance } from '@/request';
import { AxiosResponse } from 'axios';

export const deleteEntityController = async (
  id: Entity['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/module/entity/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

1. Determine parameters - Extract entity ID and any additional parameters
2. Build URL pattern - Follow /api/module/[params]/entity/${id}/ structure
3. Add imports - Include genRequestInstance and AxiosResponse
4. Generate function - Create controller with proper typing and error handling
5. Add JSDoc - Document parameters, returns, and exceptions

Progress:

• Identify entity name and module
• Determine additional parameters beyond ID
• Construct URL pattern
• Generate function signature with types
• Add error handling and JSDoc

Example 1: Input: Delete controller for "usuario" entity in "auth" module, no extra parameters Output:

TypeScript
/**
 * Deleta um usuário
 * @param id - ID do usuário
 * @returns Promise com resposta da API
 * @throws Error quando a requisição falha
 */
export const deleteUsuarioController = async (
  id: Auth.Usuario.Usuario['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/auth/usuario/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 2: Input: Delete controller for "folha" in "pessoal" module with "versao" parameter Output:

TypeScript
/**
 * Deleta uma folha de pagamento
 * @param versao - ID da versão
 * @param id - ID da folha
 * @returns Promise com resposta da API
 * @throws Error quando a requisição falha
 */
export const deleteFolhaController = async (
  versao: Planejamento.Versao.Versao['id'],
  id: Pessoal.Folha.Folha['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/pessoal/versao/${versao}/folha/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};