ts-odatajs/lib/odata.d.ts

The Olingo OData Client for JavaScript (and TypeScript) is a new cross-browser library that enables data-centric web applications by leveraging modern protocols such as JSON and OData and HTML5-enabled browser features. It's designed to be small, fast and

/** @module odata */

import * as utils from './odata/odatautils';
import * as handler from './odata/handler';
import * as metadata from './odata/metadata';
import * as net from './odata/net';
import * as netServer from './odata/net';
import * as netBrowser from './odata/net-browser';
import * as json from './odata/json';
import * as batch from './odata/batch';

import { Handler } from './odata/handler';
import { assigned, defined, throwErrorCallback } from './utils';
import { Edmx, HttpOData } from './interfaces';

export { utils, handler, metadata, net, netBrowser, netServer, json, batch };

/** Default success handler for OData.
 * @param data - Data to process.
 */
export var defaultSuccess: (data: any) => void;
export var defaultError: (error: HttpOData.Error) => void;
export var defaultHandler: Handler;
export var defaultMetadata: any[]; // TODO: Should this be Edmx.Edmx?
/** Reads data from the specified URL.
 * @param urlOrRequest - URL to read data from.
 * @param {Function} [success] - 
 * @param {Function} [error] - 
 * @param {Object} [handler] - 
 * @param {Object} [httpClient] - 
 * @param {Object} [metadata] - 
 */
export function read(urlOrRequest: string | HttpOData.Request, success?: (data: any, response: HttpOData.Response) => void, error?: (error: HttpOData.Error) => void, handler?: Handler, httpClient?: HttpOData.HttpClient, metadata?: Edmx.Edmx): HttpOData.RequestWithAbort;
/** Sends a request containing OData payload to a server.
 * @param {Object} request - Object that represents the request to be sent.
 * @param {Function} [success] - 
 * @param {Function} [error] - 
 * @param {Object} [handler] - 
 * @param {Object} [httpClient] - 
 * @param {Object} [metadata] - 
 */
export function request(request: HttpOData.Request, success?: (data: any, response: HttpOData.Response) => void, error?: (error: HttpOData.Error) => void, handler?: Handler, httpClient?: HttpOData.HttpClient, metadata?: Edmx.Edmx): HttpOData.RequestWithAbort;
/** Parses the csdl metadata to ODataJS metatdata format. This method can be used when the metadata is retrieved using something other than odatajs
 * @param {string} csdlMetadataDocument - A string that represents the entire csdl metadata.
 * @returns {Object} An object that has the representation of the metadata in odatajs format.
 */
export function parseMetadata(csdlMetadataDocument: string): Object;

export var metadataHandler: Handler;
export var jsonHandler: Handler;