Creating TypeScript Update Controllers

TypeScript
export const updateEntityController = async (
  id: Entity.Entity['id'],
  params: Entity.UpdateEntityParams,
): Promise<AxiosResponse<Entity.Entity, any>> => {
  const url = `/api/entity/${id}/`;
  const instance = genRequestInstance();

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

1. Identify entity and parameters

   • Entity name (for function naming)
   • Entity ID type
   • Additional URL parameters (if any)
   • Update payload type

2. Generate function signature

   • Function name: update{EntityName}Controller
   • Parameters: additional params first, then entity ID, then update payload
   • Return type: AxiosResponse<EntityType, any>

3. Build URL pattern

   • Base: /api/module/entity/${id}/
   • With parameters: /api/module/versao/${versao}/entity/${id}/

4. Add JSDoc documentation

   • @param for each parameter
   • @returns for response type
   • @throws for error cases

Example 1 (Simple entity): Input: Entity "User", no additional parameters

TypeScript
/**
 * Updates a user entity
 * @param id - User ID
 * @param params - Update parameters
 * @returns Promise with user data response
 * @throws Error if request fails
 */
export const updateUserController = async (
  id: User.User['id'],
  params: User.UpdateUserParams,
): Promise<AxiosResponse<User.User, any>> => {
  const url = `/api/user/${id}/`;
  const instance = genRequestInstance();

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

Example 2 (With additional parameters): Input: Entity "Funcionario" with "empresaId" parameter

TypeScript
/**
 * Updates a funcionario entity within a specific empresa
 * @param empresaId - Empresa ID
 * @param id - Funcionario ID  
 * @param params - Update parameters
 * @returns Promise with funcionario data response
 * @throws Error if request fails
 */
export const updateFuncionarioController = async (
  empresaId: Empresa.Empresa['id'],
  id: Funcionario.Funcionario['id'],
  params: Funcionario.UpdateFuncionarioParams,
): Promise<AxiosResponse<Funcionario.Funcionario, any>> => {
  const url = `/api/empresa/${empresaId}/funcionario/${id}/`;
  const instance = genRequestInstance();

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