breeze2-odata4/README.md

Library to allow OData 4 support for breezejs 2

# breeze-odata4 [![NPM version](https://badge.fury.io/js/breeze-odata4.svg)](https://npmjs.org/package/breeze-odata4) [![Build Status](https://travis-ci.org/tschettler/breeze-odata4.svg?branch=master)](https://travis-ci.org/tschettler/breeze-odata4)

> A TypeScript library to enable querying an OData 4 API using [breezejs](http://www.getbreezenow.com/breezejs)

## Prerequisites

* Breeze client npm package

## Installation

1. Install breeze-client

   ```sh
   $ npm install --save breeze-client
   ```
2. Install breeze-odata4
   ```sh
   $ npm install --save breeze-odata4
   ```

## Usage

```js
import { config, EntityManager } from "breeze-client";
import { OData4DataService, OData4UriBuilder } from 'breeze-odata4';

OData4UriBuilder.register();
OData4DataService.register();
config.initializeAdapterInstance('uriBuilder', 'OData4', true);
config.initializeAdapterInstance('dataService', 'OData4', true);

const manager = new EntityManager('/api/odata4');
manager.fetchMetadata();

```
Now we can utilize breeze to query against an OData 4 API.

## Samples

Samples can be found in the samples repo: https://github.com/tschettler/breeze-odata4-samples

## Typings

This library is currently referencing its own version of breeze-client typings, since the current typings available on DefinitelyTyped and within the breeze-client npm package are incomplete/outdated.

## License

MIT © [Travis Schettler](https://github.com/tschettler)