@ima/plugin-halson-rest-client
Version:
HAL+JSON REST API client for IMA applications.
31 lines • 1.28 kB
TypeScript
/**
* REST API response post-processor that decodes a HAL+JSON response body into
* {@code HALSONResource} instance(s), and, if required, inlines the embedded
* data.
*/
export default class HalsonResponsePostProcessor extends ResponsePostProcessor {
/**
* @inheritdoc
*/
process(response: any): Response;
/**
* Inlines the specified entities embedded within the provided entity into
* entity's fields.
*
* The embed names may contain prefixes separated by a colon ({@code :})
* from the resource name. The prefixes will not be included in the names
* of the entity fields into which the embedded resources will be inlined.
*
* The entity will be modified in-place.
*
* @param {HALSONResource} entity The pre-processed entity data with
* embedded entities that should be inlined into the entity's
* fields.
* @param {string[]} embedNames The names of the embeds to inline into the
* entity's fields.
*/
_processEntityEmbeds(entity: HALSONResource, embedNames: string[]): void;
}
import { ResponsePostProcessor } from '@ima/plugin-rest-client';
import { Response } from '@ima/plugin-rest-client';
//# sourceMappingURL=HalsonResponsePostProcessor.d.ts.map