lightrail-client/dist/requestUtils.d.ts

A Javascript and Typescript client for Lightrail

import { LightrailResponse, PaginatedLightrailResponse } from "./params";
import { Response } from "superagent";
export declare const validateRequiredParams: (keys: string[], params: object) => boolean;
/**
 * Flattens one level deep and formats as key.subkey ie: {key:{subkey:4}} => {key.subkey:4}
 * @param {object} params
 * @returns {object}
 */
export declare const formatFilterParams: (params?: object) => object;
export declare function isSuccessStatus(status: number): boolean;
/**
 * Formats a response object into a standardized/predictable response, should be used to format all responses
 * @param {request.Response} response
 * @returns {LightrailResponse<T> | PaginatedLightrailResponse<T>}
 */
export declare function formatResponse<T>(response: Response): LightrailResponse<T> | PaginatedLightrailResponse<T>;