ngx-crud icon indicating copy to clipboard operation
ngx-crud copied to clipboard

CRUD services in Angular with effortless aborting, caching and observing

NGX CRUD

CRUD services in Angular with effortless aborting, caching and observing.

Build Status Coverage Status NPM Version License

Installation

npm install ngx-crud

Setup

Import the CrudModule and HttpClientModule inside your AppModule:

import { HttpClientModule } from '@angular/common/http';
import { NgModule } from '@angular/core';
import { CrudModule } from 'ngx-crud';

@NgModule(
{
	imports:
	[
		CrudModule,
		HttpClientModule
	]
})
export class AppModule
{
}

Usage

Extend the ExampleService from the CrudService:

import { Injectable } from '@angular/core';
import { CrudService } from 'ngx-crud';
import { RequestBody, ResponseBody } from './example.interface';

import { environment } from '@environments';

@Injectable()
@ApiUrl(environment.apiUrl)
@ApiRoute(environment.apiRoutes.example)
export class ExampleService extends CrudService<RequestBody, ResponseBody>
{
}

Use the HTTP operations as needed:

exampleService.create(body, options);
exampleService.read(id, options);
exampleService.find(options);
exampleService.update(id, body, options);
exampleService.patch(id, body, options);
exampleService.delete(id, options);
exampleService.custom(method, options);

Documentation

Read the documentation for a deep dive.