Saltearse al contenido

deleteEnum

La función deleteEnum elimina un modelo Enum. Es el equivalente en JavaScript/TypeScript del endpoint REST DELETE /model/enum/:id.

Ejemplo:

import { isApiClientError } from '@content-island/api-client';
try {
await client.deleteEnum(enumId);
// se resuelve a `true` en caso de éxito
} catch (error) {
if (isApiClientError(error) && error.code === 'CONFLICT') {
// un campo de entidad referencia este enum — reapunta o elimina primero ese campo
}
}

Interface

export interface ApiClient {
deleteEnum: (enumId: string) => Promise<boolean>;
// ... otros métodos
}

Parámetros

NombreDescripción
enumIdEl id del enum a eliminar.

Salida

Se resuelve a true cuando el enum se elimina (HTTP 204). En caso de fallo, lanza un ApiClientError tipado:

  • CONFLICT (409) — un campo de entidad de tipo enum referencia este enum. No hay forma de forzarlo; elimina o reapunta primero el campo que lo referencia.
  • NOT_FOUND (404) — no existe ningún enum con ese id.