ServiceBase

Abstração de requisições HTTP

Métodos

save

Este método realiza POST e PUT (Caso informe o id).

getAll

Este método retorna uma lista de objetos através de um filtro (Opcional).

getById

Este método retorna um objeto pelo id.

delete

Este método exclui um objeto pelo id.

deleteMany

Este método exclui um ou mais objetos por uma lista de ids.

exportByService

Este método exporta em csv ou xlsx dados através de paginação.

Ao executar este método, será exibido um Loader Page contendo o progresso da exportação.

getDatatable

Este método é obrigatório de implementação, tendo como objetivo a padronização dos dados retornados para o componente de Datatable.

Configuração

Para que funcione conforme esperado, inclua a partir do método super no construtor da classe o HttpClient e o nome do mainResource da API que deseja integrar, como por exemplo:

https://{HOST}/{mainResource}

Esta classe permite a utilização de Mockup, informando no construtor através no método super as opções necessárias.

import { CatServiceBase } from '@catrx/ui/common';

export class ExampleService extends CatServiceBase {
  constructor(httpClient: HttpClient) {
    super(httpClient, 'cat', {
      useMockup: true,
      mockupStartBase: [
        {...}
      ]
    })
  }
}

A opção mockupStartBase é opcional e ela definirá o estado inicial de seu mockup, populando uma lista inicial, que poderá ser acessada através do método getAll.

O host da API que será integrada por padrão utiliza a informada em seu arquivo environment pelo atributo hostApi, porém, caso queira utilizar algum personalizado, basta informar nas opções através do método super.

import { CatServiceBase } from '@catrx/ui/common';

export class ExampleService extends CatServiceBase {
  constructor(httpClient: HttpClient) {
    super(httpClient, 'cat', {
      customHost: 'https://example.com'
    })
  }
}