# ember-batch-request

**Repository Path**: mirrors_netflix/ember-batch-request

## Basic Information

- **Project Name**: ember-batch-request
- **Description**: Ember Addon to make Batch Requests to Rails Application
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ember-batch-request

[![NetflixOSS Lifecycle](https://img.shields.io/osslifecycle/Netflix/osstracker.svg)]()

Adapter add on for making Batch Requests in Ember Applications.

  * Customizable Adapter
  * Returns Success and Failure responses
  * Ability to skip store update in bulk scenario
  * Create or Update or Delete N records in 1 XHR call

### Getting Started

As any other ember-cli add on, run:
  ```
  ember install ember-batch-request
  ```
  
### Setup

Since the [Rails middleware](https://github.com/Netflix/batch_request_api) depends on the url ```/api/v1/batch_sequential``` or ```/api/v1/batch_sequential```, please add the following config to environment.js

```
ENV.apiNamespace = 'api/v1';
ENV.apiBatchUrl = 'batch_parallel'; (or batch_sequential)
```

### Usage

  **BatchCreate**

  ```javascript
  this.store.batchCreate(arrayOfObjects).then((response) => { });
  ```

  **BatchUpdate**

  ```javascript
  this.store.batchUpdate(arrayOfObjects).then((response) => { });
  ```

  **BatchDelete**

  ```javascript
  this.store.batchDelete(arrayOfObjects).then((response) => { });
  ```

### How to skip Store Updates during Create or Update

Just pass the option { skipStoreUpdate: true } in batchCreate or batchUpdate

  ```javascript
  this.get('store').batchCreate(arrayOfObjects, { skipStoreUpdate: true })
  ```

### Response

  ```javascript
  {
    completedResponses: [],
    errorResponses: []
  }
  ```

### ToDo
Update the store on creates
### Contributing

If you would like to contribute, you can fork the project, edit, and make a pull request.

### Tests

Please make sure that the test pass by running ember test. If you had a new functionality, add tests for it.

### Note

Currently works with JSON API spec