Options
All
  • Public
  • Public/Protected
  • All
Menu

breeze-odata4 - v1.0.0

breeze-odata4 NPM version Build Status Coverage Status

A TypeScript library to enable querying an OData 4 API using breezejs

Prerequisites

  • Breeze client npm package

Installation

  1. Install breeze-client

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

    $ npm install --save breeze-odata4
    

Usage

import { EntityManager } from 'breeze-client';
import { BreezeOData4 } from 'breeze-odata4';

BreezeOData4.configure();

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

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

Documentation

See https://tschettler.github.io/breeze-odata4/ for project documentation.

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

Generated using TypeDoc