baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
46 lines (45 loc) • 2.04 kB
TypeScript
/**
* @module dynamicResourceBatchRoute
* @description DynamicResourceBatchRoute Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use DynamicResourceBatchRoute 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 DynamicResourceBatchRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly createRoute: string;
readonly updateRoute: string;
readonly patchRoute: string;
readonly deleteRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses create route. This URI template does not expose any additional options.
* @method
* @example dynamicResourceBatchRoute.create();
*/
create(): any;
/**
* Parses update route. This URI template does not expose any additional options.
* @method
* @example dynamicResourceBatchRoute.update();
*/
update(): any;
/**
* Parses patch route. This URI template does not expose any additional options.
* @method
* @example dynamicResourceBatchRoute.patch();
*/
patch(): any;
/**
* Parses delete route. This URI template does not expose any additional options.
* @method
* @example dynamicResourceBatchRoute.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 service.
*/