baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
68 lines (67 loc) • 3.2 kB
TypeScript
/**
* @module keyValueRoute
* @description Baasic Key Value Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Key Value Route Service 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 { IGetRequestOptions, IOptions } from '../../common/contracts';
import { IKeyValue } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class KeyValueRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly findRoute: string;
readonly getRoute: string;
readonly createRoute: string;
readonly updateRoute: string;
readonly deleteRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses find key value route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string value used to identify key value resources using the phrase search.
* - `page` - A value used to set the page number, i.e. to retrieve certain key value subset from the storage.
* - `rpp` - A value used to limit the size of result set per page.
* - `sort` - A string used to set the key value property to sort the result collection by.
* - `embed` - Comma separated list of resources to be contained within the current representation.
* @method
* @param options Query resource options object.
* @example keyValueRoute.find(options);
**/
find(options: IOptions): any;
/**
* Parses get key value route which must be expanded with the Id of the previously created key value resource in the system.
* @method
* @param id Key value resource unique identifier.
* @param options Query resource options object.
* @example keyValueRoute.get();
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses create key value route; this URI template does not expose any additional options.
* @method
* @example keyValueRoute.create();
**/
create(): any;
/**
* Parses update key value route.
* @method
* @param data Key Value object used to create update route.
* @example keyValueRoute.update(data);
*/
update(data: IKeyValue): any;
/**
* Parses delete key value route.
* @method
* @param data Key Value object used to create delete route.
* @example keyValueRoute.delete(data);
*/
delete(data: IKeyValue): any;
}
/**
* @copyright (c) 2017 Mono Ltd
* @license MIT
* @author Mono Ltd
* @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.
*/