🧠
ngx-crud
  • Introduction
  • API
    • HTTP Operations
    • HTTP Aborting
    • HTTP Caching
    • HTTP Observing
    • HTTP Options
    • HTTP Context
    • HTTP Headers
    • HTTP Params
    • Service Instance
    • Service Options
  • Reference
    • Modules
      • AbortModule
      • CacheModule
      • ObserveModule
      • CrudModule
    • Services
      • AbortService
      • CacheService
      • CommonService
      • CrudService
      • CustomService
      • DeleteService
      • FindService
      • GetService
      • ObserveService
      • PatchService
      • PostService
      • PutService
    • Interceptors
      • AbortInterceptor
      • CacheInterceptor
      • ObserveInterceptor
    • Decorators
      • @ApiUrl
      • @ApiRoute
    • Helpers
      • createUrl
      • createUrlWithId
      • stripUrlParams
  • Examples
    • Services
      • Fully Typed Collection
      • Limited Singleton
    • Components
      • Loader
    • Effects
      • ProfilerEffect
      • ErrorEffect
      • OfflineEffect
  • Links
    • GitHub
Powered by GitBook
On this page
  • Create
  • Read
  • Find
  • Update
  • Patch
  • Delete
  • Custom
  1. API

HTTP Operations

Create

Fires a POST request to create a single resource:

crudService.create<
	RequestBody = CreateRequestBody,
	ResponseBody = CreateResponseBody
>(body : NoInfer<RequestBody>, options ?: Options) : Observable<ResponseBody>

Read

Fires a GET request to read a single resource:

crudService.read<
	ResponseBody = ReadResponseBody
>(id : Id, options ?: Options) : Observable<ResponseBody>

Find

Fires a GET request to find multiple resources:

crudService.find<
	ResponseBody = FindResponseBody
>(options ?: Options) : Observable<ResponseBody>

Update

Fires a PUT request to completely update a single resource:

crudService.update<
	RequestBody = UpdateRequestBody,
	ResponseBody = UpdateResponseBody
>(id : Id, body : NoInfer<RequestBody>, options ?: Options) : Observable<ResponseBody>

Patch

Fires a PATCH request to partially update a single resource:

crudService.patch<
	RequestBody = PatchRequestBody,
	ResponseBody = PatchResponseBody
>(id : Id, body : NoInfer<RequestBody>, options ?: Options) : Observable<ResponseBody>

Delete

Fires a DELETE request to delete a single resource:

crudService.delete<
	ResponseBody = DeleteResponseBody
>(id : Id, options ?: Options) : Observable<ResponseBody>

Custom

Fires a custom request:

crudService.custom<
	RequestBody = CustomRequestBody,
	ResponseBody = CustomResponseBody
>(method : Method, options ?: OptionsWithBody<NoInfer<RequestBody>>) : Observable<ResponseBody>
PreviousAPINextHTTP Aborting

Last updated 3 months ago