Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ngx-crud

henryruhs685MIT19.0.1TypeScript support: included

CRUD services in Angular with effortless aborting, caching and observing

angular, http, crud, aborting, caching, observing

readme

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 provideHttpClient inside your AppModule:

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

@NgModule(
{
    imports:
    [
        CrudModule
    ],
    providers:
    [
        provideHttpClient(withInterceptorsFromDi())
    ]
})
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.