baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
33 lines (32 loc) • 1.6 kB
TypeScript
/**
*@module lookupRoute
* @description Baasic Lookup Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Lookup Route Definition to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.
*/
import { BaseRoute } from '../../../common';
import { IAppOptions } from '../../../core/contracts';
export declare class LookupRoute extends BaseRoute {
protected appOptions: IAppOptions;
/**
* Get route with route and query parameters.
**/
getRoute: string;
/**
* Get access section route with route and query parameters.
**/
getAccessSectionRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get route which can be expanded with additional options. Supported items are:
* - `embed` - Comma separated list of resources to be contained within the current representation.
* @method
* @example baasicLookupRouteService.get(data);
**/
get(data: any): any;
}
/**
* @overview
***Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- [URI Template](https://github.com/Baasic/uritemplate-js) syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
- All end-point objects are transformed by the associated route service.
*/