npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ngx-batch-requests

v3.0.0

Published

Angular (5+) HTTP batching module to reduce the number of HTTP requests and increase performance

Downloads

200

Readme

ngx-batch-requests

Angular (5+) HTTP batching module to reduce the number of HTTP requests and increase performance

Get Started

Installation

You can install this package locally with npm.

npm i ngx-batch-requests

Usage

Add BatchRequestsModule to your AppModule imports. Make sure Angular's HttpClientModule is also imported since this module makes use of it.

Add BatchRequestsInterceptor as an interceptor.

In your AppModule providers, you can set the configuration like so:


{ provide: BATCH_REQUESTS_CONFIG,
  useValue: {
    debug: false,
    bufferTimeSpan: 250,
    bufferMaxSize: 20,
  
    batchPath: '/api/$batch',
    batchMethod: 'POST',
  
    defaultRequestOptions: {
      withCredentials: true
    },
  
    parseResponse: (response, request) => response,
  
    shouldBatch: (request) => true,
  }
}

Note that you do NOT need to provide all of these configuration options. Above is the default configuration which will be deep merged with whatever additional or replacement options you provide. So if you don't do this step, these are the options which will be used out of the box.

Example

Here is a simple example of how to import and configure BatchRequests:

import { HTTP_INTERCEPTORS, HttpClientModule } from '@angular/common/http';
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { BatchRequestsModule, BatchRequestsInterceptor, BATCH_REQUESTS_CONFIG } from 'ngx-batch-requests';

@NgModule({
  imports: [
    BrowserModule,
    HttpClientModule,
    BatchRequestsModule,
  ],
  providers: [
    { provide: HTTP_INTERCEPTORS, useClass: BatchRequestsInterceptor, multi: true },
    { provide: BATCH_REQUESTS_CONFIG,
      useValue: {
        batchPath: '/api/batch',
      }
    },
  ],
})
export class AppModule { }

You'll note that in this example the only thing we cared to change was the batchPath. Now, any requests that come in within 250ms of each other will be sent in batches of up to 20, instead of individually.

Other Interceptors

I recommend making this the LAST interceptor in your providers. This allows other interceptors to handle the batched requests individually instead of seeing only the batched call they're grouped in, and allows more consistent response handling.

History

This is meant as a replacement for ngx-http-batcher, as that project has not been updated to work with interceptors or HttpClient.

The changes are based heavily on the work done by srikrsna which I later heavily modified.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.