Function callApi

Parameters

• path: string

  endpoint (chemin relatif) auquel adresser la requête. Exemple : accounts/login. La liste des endpoints est disponible sur JVFlux.
• Optionaloptions: {
      allowedStatusErrors?: number[];
      cookies?: Record<string, string>;
      data?: any;
      headers?: Record<string, string>;
      method?: HttpMethod;
      query?: Record<string, any>;
  } = {}

  options permettant de modifier le comportement de la requête

  • OptionalallowedStatusErrors?: number[]

    contient les statuts HTTP signalant un échec à ignorer, c'est-à-dire ceux qui ne causeront pas l'erreur JvcResponseError si renvoyés. Contient par défaut les statuts 400 (Bad Request) et 404 (Not Found)

  • Optionalcookies?: Record<string, string>

    les cookies à envoyer sous forme d'objet associant au nom du cookie sa valeur

  • Optionaldata?: any

    le corps de la requête (pour méthodes POST et PUT). Son format est arbitraire est dépend du header Content-Type fourni : application/json (header par défaut), application/x-www-form-urlencoded et multipart/form-data recquièrent tous un objet. Pour tout autre header tel que application/octet-stream, la valeur de ce paramètre sera passée telle que donnée par l'utilisateur à la requête

  • Optionalheaders?: Record<string, string>

    les en-têtes à envoyer sous forme d'objet associant au nom de l'en-tête sa valeur. Une en-tête particulièrement importante est Content-Type car elle déterminera la manière dont sera traitée le paramètre optionnel data (voir ci-dessus)

  • Optionalmethod?: HttpMethod

    méthode HTTP de la requête (GET par défaut)

  • Optionalquery?: Record<string, any>

    les paramètres URL à passer à la requête, sous forme d'objet associant au paramètre sa valeur