Rapiq

Appearance

On this page

Build ​

buildQuery ​

Build a query string from a provided BuildInput object for a generic Record <T>. The allowed input keys are values of the Parameter or URLParameter enum.

Type

ts
declare function buildQuery<T>(record: BuildInput<T>): string;

Example

typescript
import {
    buildQuery
} from "rapiq";

type User = {
    id: number,
    name: string,
    age?: number
}

const query: string = buildQuery<User>({
    fields: ['+age'],
    relations: {
        name: '~pe'
    }
});

console.log(query);
// ?fields=+age&filter[name]=~pe

Type Parameters

NameDescription
TA type, interface, or class which represent the data structure.

Parameters

NameTypeDescription
inputBuildInput<T>Input specification more.

Returns

string

The function returns a string, which can be parsed with the parseQuery function.

I.e. /users?page[limit]=10&page[offset]=0&include=profile&filter[id]=1&fields[user]=id,name

References

BuildInput ​

typescript
type BuildInput<
    T extends Record<string, any>
> = {
    [P in Parameter | URLParameter]?: BuildParameterInput<P, T>
}

References

BuildParameterInput ​

typescript
declare type BuildParameterInput<
    P extends ParameterType | URLParameterType,
    T extends Record<string, any> = Record<string, any>
>;

is a generic type and returns the input structure for a given parameter type:

References