baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
39 lines (38 loc) • 1.8 kB
TypeScript
/**
* @module templatingBatchRoute
* @description Baasic Templating Batch Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Templating Batch Route Definition to obtain a 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 TemplatingBatchRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly createRoute: string;
readonly updateRoute: string;
readonly deleteRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses create route; this URI template does not expose any additional options.
* @method
* @example templatingBatchRoute.create();
**/
create(): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @example templatingBatchRoute.update();
**/
update(): any;
/**
* Parses remove route; this URI template does not expose any additional options.
* @method
* @example templatingBatchRoute.delete();
**/
delete(): any;
}
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](https://github.com/Baasic/baasic-rest-api/wiki) 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 definition.
*/