@lindeneg/core-http-req NPM

@lindeneg/core-http-req

bundle-size license

A fetch wrapper for easy use with JSON requests/responses.

Installation

yarn add @lindeneg/core-http-req

Usage

import HttpReq from '@lindeneg/core-http-req';

interface User = {
  id: number;
  username: string;
  email: string;
};

interface ExpectedError = {
  code: number;
  message: string;
};

const httpReq = new HttpReq(config);

const {
  data, // has type: User | undefined
  error, // has type: ExpectedError | undefined
  statusCode,
} = await httpReq.getJson<User, ExpectedError>('/user/1', options);

Config

An optional object of type:

type Config = {
  /* url to be used by all requests. If a url is 
     given to specific requests, it's simply appended. */
  baseUrl?: string;
  /* shared request config to be used by all requests. 
     if the request itself is called with a config, 
     the two are merged with the shared config yielding to overwrites. */
  sharedOptions?: RequestConfig;
  /* cache config to be used for caching get requests */
  cacheConfig?: {
    strategy: CacheStrategy;
    trim?: number;
    ttl?: number;
  };
  /* if true, will set listeners to abort active requests on unload event */
  shouldSetListeners?: boolean;
};

Methods

All methods returns a Promise that resolves to an object of type RequestResult.

type CustomError = Partial<Error>;

type RequestResult<T, E extends CustomError> = {
  data?: T; // data type expected
  error?: E; // error type expected
  fromCache?: boolean; // data served from cache?
  statusCode?: number; // response.status number
};

The type of properties data and error can be specified on a per request basis but it should be noted that a non-ok response, if any body is included, is expected to be json.

request

This is the base for all requests and is called by all below methods. It contains a standard Response object in the data property of RequestResult.

function request<E extends CustomError>(
  url: string,
  options?: RequestInit
): Promise<RequestResult<Response, E>>;

getJson

GET JSON. If a CacheStrategy is defined, response data will be cached and served when appropriate. Properties body and method are omitted from the optional options object.

function getJson<T extends EmptyObj, E extends CustomError>(
  url: string,
  options?: RequestInit // properties 'body' and 'method' omitted
): Promise<RequestResult<T, E>>;

sendJson

POST/PATCH/PUT JSON.

function sendJson<T extends EmptyObj, E extends CustomError>(
  url: string,
  body: EmptyObj,
  method: ReqMethod.POST | ReqMethod.PUT | ReqMethod.PATCH = ReqMethod.POST,
  options?: PartialRequestConfig // contains json Content-Type in headers by default
): Promise<RequestResult<T, E>>;

deleteJson

DELETE JSON.

function deleteJson<T extends EmptyObj, E extends CustomError>(
  url: string,
  body?: EmptyObj,
  options?: RequestInit // property 'method' omitted
): Promise<RequestResult<T, E>>;