battlemetrics-client
Version:
TypeScript client library for the BattleMetrics API
34 lines • 1.13 kB
TypeScript
import { ServerListParams } from "../types/serversParams";
/**
* Generic function to transform any parameter object into a query string format.
* Handles nested objects, arrays, and special cases like colon-separated keys.
*
* @param params - Any parameter object to transform
* @returns A query string (without the leading '?')
*
* @example
* ```typescript
* const params = {
* filter: {
* game: "ark",
* status: "online",
* "players:min": 42,
* "players:max": 100
* },
* include: "serverGroup",
* sort: "players"
* };
*
* const query = buildQueryString(params);
* // Returns: "filter[game]=ark&filter[status]=online&filter[players][min]=42&filter[players][max]=100&include=serverGroup&sort=players"
* ```
*/
export declare function buildQueryString(params: unknown): string;
/**
* Convenience function specifically for ServerListParams.
*
* @param params - The server list parameters to transform
* @returns A query string (without the leading '?')
*/
export declare function buildServerQueryString(params: ServerListParams): string;
//# sourceMappingURL=buildQueryString.d.ts.map