odata
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.1 • Public • Published

    o.js

    o.js is a isomorphic Odata Javascript library to simplify the request of data. The main goal is to build a standalone, lightweight and easy to understand Odata lib.

    Install

    npm install odata
    

    Or you can use npm install o.js which will resolve the same package

    Usage in browser

    In a module or Typescript

    import { o } from 'odata';
    
    (async () => {
      // chaining
      const data1 = await o('http://my.url')
        .get('resource')
        .query({ $top: 3 });
    
      // handler
      const oHandler = o('http://my.url');
      const data2 = await oHandler
        .get('resource')
        .query({ $top: 3 });
    })();

    Or in a script tag

    <script src="node_modules/odata/dist/umd/o.js">

    It's then placed on the window.odata:

    window.odata
      .o('http://my.url')
      .get('resource')
      .query({ $top: 3 })
      .then(function (data) {});

    Usage in node

    const o = require('odata').o;
    
    // promise example
    o('http://my.url')
      .get('resource')
      .then((data) => console.log(data));

    CRUD examples

    The following examples using async/await but for simplicity we removed the async deceleration. To make that work this example must be wrapped in an async function or use promise.

    Create (POST):

    const data = {
      FirstName: "Bar",
      LastName: "Foo",
      UserName: "foobar",
    }
    
    const response = await o('http://my.url')
      .post('User', data)
      .query(); 
    
    console.log(response); // E.g. the user 

    Read (GET):

    const response = await o('http://my.url')
      .get('User')
      .query({$filter: `UserName eq 'foobar'`}); 
    
    console.log(response); // If one -> the exact user, otherwise an array of users

    Update (Patch):

    const data = {
      FirstName: 'John'
    }
    
    const response = await o('http://my.url')
      .patch(`User('foobar')`, data)
      .query(); 
    
    console.log(response); // The result of the patch, e.g. the status code

    Delete:

    const response = await o('http://my.url')
      .delete(`User('foobar')`)
      .query(); 
    
    console.log(response); // The status code

    Options

    You can pass as a second option into the o constructor options. The signature is:

    function o(rootUrl: string | URL, config?: OdataConfig | any)

    Basic configuration is based on RequestInit and additional odata config. By default o.js sets the following values:

    {
        batch: {
          boundaryPrefix: "batch_",
          changsetBoundaryPrefix: "changset_",
          endpoint: "$batch",
          headers: new Headers({
            "Content-Type": "multipart/mixed",
          }),
          useChangset: false,
          useRelativeURLs: false,
        },
        credentials: "omit",
        fragment: "value",
        headers: new Headers({
          "Content-Type": "application/json",
        }),
        mode: "cors",
        redirect: "follow",
        referrer: "client",
        onStart: () => null,
        onFinish: () => null,
        onError: () => null,
      }
    

    Query

    The following query options are supported by query(), fetch() and batch() by simply adding them as object:

    $filter?: string;
    $orderby?: string;
    $expand?: string;
    $select?: string;
    
    $skip?: number;
    $top?: number;
    $count?: boolean;
    $search?: string;
    $format?: string;
    $compute?: string;
    $index?: number;
    [key: string]: any; // allows to add anything that is missing

    The $count flag will add an inline count property as metadata to a query response. In order to just retrieve the count, you'll have query the $count resource, such as

    oHandler.get('People/$count').query().then((count) => {})

    The queries are always attached as the URLSearchParams.

    Just fetching

    The lib tries to parse the data on each request. Sometimes that is not wanted (e.g. when you need a status-code or need to access odata meta data), therefor you can use the .fetch method that acts like the default fetch.

    Batching

    By default o.js chains request in sequent. You can batch them together by using batch(). They are then send to the defined batch endpoint in the config. Changsets are at the moment in a experimental phase and needs to be enabled in the config.

    Polyfills

    Polyfills are automatically added for node.js. If you like polyfills to support IE11 please include the dist/umd/o.polyfill.js file.

    Keywords

    none

    Install

    npm i odata

    DownloadsWeekly Downloads

    2,142

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    1.46 MB

    Total Files

    74

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar