hal-ts/lib/actions/object.d.ts

Package to format api responses into hal format

import { IHalEmbededObject, IHalObjectResponse } from "../types/object";
/**
 * Takes an embeded object and transpiles it to a response object
 * @param embededObject
 * @returns a new response object to embed
 */
export declare const prepareEmbededData: (embededObject: IHalEmbededObject | undefined) => IHalObjectResponse | undefined;
/**
 * Typeguard for Hal embeded array
 *
 * @param obj any object to be tested
 * @returns either if is response Hal embeded array
 */
export declare const isHalEmbededObjectArray: (obj: IHalEmbededObject[] | IHalEmbededObject | undefined) => obj is IHalEmbededObject[];
/**
 * Typeguard for Hal embeded object
 *
 * @param obj any object to be tested
 * @returns either if is response Hal embeded object
 */
export declare const isHalEmbededObject: (obj: IHalEmbededObject[] | IHalEmbededObject | undefined) => obj is IHalEmbededObject;
/**
 * Typeguard for HalResponse object
 *
 * @param obj any object to be tested
 * @returns either if is response HalResponse object
 */
export declare const isHalObjectResponse: (obj: IHalObjectResponse | IHalObjectResponse[] | undefined) => obj is IHalObjectResponse;
/**
 * Typeguard for HalResponseArray
 *
 * @param obj any object to be tested
 * @returns either if is response HalResponseArray
 */
export declare const isHalObjectResponseArray: (obj: IHalObjectResponse | IHalObjectResponse[] | undefined) => obj is IHalObjectResponse[];