imgix-management-js/types/index.d.ts

A Javascript library that wraps the imgix management API

import { RequestInit, BodyInit } from 'node-fetch';

// JSON types via https://github.com/microsoft/TypeScript/issues/1897#issuecomment-338650717
type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
export interface JsonMap extends Record<string, AnyJson> {}
export interface JsonArray extends Array<AnyJson> {}

export interface RequestResponse {
  data: JsonMap | JsonArray;
  included: JsonArray;
  jsonapi: JsonMap;
  meta: JsonMap;
}

export class APIError extends Error {
  constructor(message: string, data: JsonMap | null, status: number);
  response: JsonMap;
  message: string;
  status: number;
  toString(): string;
}

interface JsonBody {
  body?: BodyInit | JsonMap;
}

type RequestOptions = RequestInit | JsonBody;

declare class ImgixAPI {
  apiKey: string;
  version: number;
  pluginOrigin: string;
  static APIError: APIError;

  constructor(opts: {
    apiKey: string;
    version?: number;
    pluginOrigin?: string;
  });

  /**
   * Note: on failure, this will return a type Promise\<APIError>
   * @see APIError
   */
  request(path: string, options?: RequestOptions): Promise<RequestResponse>;
}

export default ImgixAPI;