Saltearse al contenido

deleteModel

La función deleteModel elimina un modelo Entity y todas las entradas de contenido de ese tipo. Es el equivalente en JavaScript/TypeScript del endpoint REST DELETE /model/entity/:id.

Ejemplo:

import { isApiClientError } from '@content-island/api-client';
try {
await client.deleteModel(modelId);
// se resuelve a `true` en caso de éxito
} catch (error) {
if (isApiClientError(error) && error.code === 'CONFLICT') {
// el modelo está referenciado por un campo de otro modelo — reapúntalo primero
}
}

Interface

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

Parámetros

NombreDescripción
modelIdEl id de la entidad a eliminar.

Salida

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

  • CONFLICT (409) — el modelo está referenciado por un campo relation de otro modelo. No hay forma de forzarlo; elimina o reapunta primero el campo que lo referencia.
  • NOT_FOUND (404) — no existe ninguna entidad con ese id.