TypeScript interfaces

IRequestOptions

interface IRequestOptions {
  query?: Record<string, string | Array<string> | object>;
  cacheOptions?: {
    cachingStrategy?: CachingStrategy;
    maxAge?: number;
    skipCache?: boolean;
  };
  networkConfig?: {
    headers?: Record<string, string>;
  };
}

IResponseObject

interface IResponseObject {
  data?: object;
  error?: Error;
  headers?: Headers;
  requestHeaders?: Record<string, string>;
  status?: number;
  collection?: PureCollection;
  type?: IType | typeof PureModel;
}

IPipeOperator

type IPipeOperator = (request: BaseRequest) => void;

IInterceptor

type IInterceptor<T extends PureModel = PureModel> = (
  request: IFetchOptions,
  next?: INetworkHandler,
) => Promise<Response<T>>;

INetworkHandler

type INetworkHandler<T extends PureModel = PureModel> = (
  request: IFetchOptions,
) => Promise<Response<T>>;

IFetchOptions

interface IFetchOptions {
  url: string;
  options?: IRequestOptions;
  data?: string | object | FormData;
  method: HttpMethod;
  collection?: PureCollection;
  skipCache?: boolean;
  views?: Array<View>;
  type?: IType | typeof PureModel;
}