UNPKG

@ng-app-framework/api

Version:

![Travis CI](https://travis-ci.org/ng-app-framework/api.svg?branch=master)

44 lines (43 loc) 1.42 kB
import { EndpointCaller } from "./Impl/EndpointCaller"; import { EndpointValidator } from "./Impl/EndpointValidator"; import { Observable } from "rxjs/Rx"; import { EndpointEvents } from "./EndpointEvents"; export interface EndpointArgument { name: string; type: string; required: boolean; } export interface EndpointDocumentation { method: 'get' | 'post' | 'put' | 'delete'; name: string; arguments: EndpointArgument[]; request?: any; response?: any; } export declare class Endpoint { endpointCaller: EndpointCaller; module: string; customBaseUri: string; path: string; validator: EndpointValidator; metadata: any; events: EndpointEvents; documentation: EndpointDocumentation[]; placeholders: { [key: string]: { key: string; remove: boolean; }; }; constructor(endpointCaller: EndpointCaller); request(method: string, requestData?: any): Observable<any>; private continueWithRequest(method, requestData); private onResponseSuccess(transformedResponse); private onRequestSuccess(transformed); private onApiRequestFailure(err, caught); private onRequestValidationSuccess(); private onValidationFailure(location, err, caught); transformResponse(response: any): any; getAbsoluteUrl(requestData: any): string; protected getReplacedPath(requestData: any): string; }