Aller au contenu principal

QueryParams

Ensemble de fonctions permettant de manipuler les query params passés aux requêtes http.

info

Les fonctions suivantes dépendent de la librairie query-string.

Références

const generateQueryParams: <T = unknown>(params: Record<string, T>) => string;

generateQueryParams

Permets de transformer un objet en chaîne de caractères, selon le format attendu par les API Creatic.

  • Les valeurs null et undefined sont ignorées.
  • Les chaînes de caractères vides sont ignorées.
  • Les tableaux sont transformés en chaînes de caractères, séparées par des virgules. ['a', 'b', 'c'] devient 'a,b,c'.

Paramètres

  • obj
    • Requis
    • Objet à transformer (exemple : { a: 1, b: 2, c: 3 }).

Exemple

import { generateQueryParams } from '@creatic/reactic-utils';

const obj = {
a: 1,
b: 2,
c: 3,
d: null,
e: undefined,
f: '',
g: ['a', 'b', 'c']
};

generateQueryParams(obj); // 'a=1&b=2&c=3&g=a,b,c'