odata/src/OdataConfig.ts

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.

import { OHandler } from "./OHandler";
import { OdataQuery } from "./OdataQuery";

export interface OdataBatchConfig {
  endpoint?: string;
  headers?: Headers;
  boundaryPrefix?: string;
  useChangset: boolean;
  changsetBoundaryPrefix?: string;
  /**
   * When truthy, relative URL's will be used in batch elements
   */
  useRelativeURLs: boolean;
}

export type OdataConfig = RequestInit & {
  /**
   * The URL to request data from
   */
  rootUrl?: URL | string;

  /**
   * An default query
   */
  query?: URLSearchParams | OdataQuery;

  /**
   * The fragment to parse data from
   * Default is: value
   */
  fragment: string;

  /**
   * Batch configuration (experimental)
   */
  batch?: OdataBatchConfig;

  /**
   * Set to true to disable auto polyfilling
   */
  disablePolyfill?: boolean;

  /**
   * A function which is called on each start of a request
   */
  onStart: (oHandler: OHandler) => null;

  /**
   * A function which is called when a request has finished
   */
  onFinish: (oHandler: OHandler, res?: Response) => null;

  /**
   * A function which is called when a request has a error
   */
  onError: (oHandler: OHandler, res: Response) => null;
};