Types

HMPLRequestInit

interface HMPLRequestInit {
  mode?: RequestMode;
  cache?: RequestCache;
  redirect?: RequestRedirect;
  referrerPolicy?: ReferrerPolicy;
  integrity?: string;
  referrer?: string;
  get?: HMPLRequestGet;
  body?: BodyInit | null;
  signal?: AbortSignal | null;
  window?: any;
  credentials?: RequestCredentials;
  headers?: HMPLHeadersInit;
  timeout?: number;
}

HMPLInstance

interface HMPLInstance {
  response: undefined | Element | null;
  status?: HMPLRequestStatus;
  requests?: HMPLRequest[];
}

HMPLInstanceContext

interface HMPLInstanceContext {
  request: HMPLRequestContext;
}

interface HMPLRequestContext {
  event?: Event;
  clearInterval?: () => void;
}

HMPLRequest

interface HMPLRequest {
  response: undefined | Element | null | ChildNode[];
  status: number;
  id?: string;
}

HMPLRequestGet

type HMPLRequestGet = (params: HMPLRequestGetParams) => void;

HMPLRequestGetParams

interface HMPLRequestGetParams {
  prop: string;
  value: any;
  context: HMPLInstanceContext;
  request?: HMPLRequest;
}

HMPLRequestInfo

interface HMPLRequestInfo {
  src: string;
  method?: string;
  initId?: string | number;
  after?: string;
  repeat?: boolean;
  memo?: boolean;
  interval?: number;
  allowedContentTypes?: HMPLContentTypes;
  indicators?: HMPLIndicator[];
  sanitize?: HMPLSanitize;
  disallowedTags?: HMPLDisallowedTags;
  autoBody?: boolean | HMPLAutoBodyOptions;
}

HMPLCompile

type HMPLCompile = (
  template: string,
  options?: HMPLCompileOptions
) => HMPLTemplateFunction;

HMPLCompileOptions

interface HMPLCompileOptions {
  memo?: boolean;
  autoBody?: boolean | HMPLAutoBodyOptions;
  allowedContentTypes?: HMPLContentTypes;
  sanitize?: HMPLSanitize;
  disallowedTags?: HMPLDisallowedTags;
  sanitizeConfig?: Config;
}

HMPLTemplateFunction

type HMPLTemplateFunction = (
  options?:
    | HMPLIdentificationRequestInit[]
    | HMPLRequestInit
    | HMPLRequestInitFunction
) => HMPLInstance;

HMPLClearInterval

type HMPLClearInterval = () => void;

HMPLAutoBodyOptions

interface HMPLAutoBodyOptions {
  formData?: boolean;
}

HMPLInitalStatus

type HMPLInitalStatus =
  | "pending"
  | "rejected"
  | 100
  | 101
  | 102
  | 103
  | 300
  | 301
  | 302
  | 303
  | 304
  | 305
  | 306
  | 307
  | 308
  | 400
  | 401
  | 402
  | 403
  | 404
  | 405
  | 406
  | 407
  | 408
  | 409
  | 410
  | 411
  | 412
  | 413
  | 414
  | 415
  | 416
  | 417
  | 418
  | 421
  | 422
  | 423
  | 424
  | 425
  | 426
  | 428
  | 429
  | 431
  | 451
  | 500
  | 501
  | 502
  | 503
  | 504
  | 505
  | 506
  | 507
  | 508
  | 510
  | 511;

HMPLIndicatorTrigger

type HMPLIndicatorTrigger = HMPLInitalStatus | "error";

HMPLRequestStatus

type HMPLRequestStatus =
  | HMPLInitalStatus
  | 200
  | 201
  | 202
  | 203
  | 204
  | 205
  | 206
  | 207
  | 208
  | 226;

HMPLContentTypes

type HMPLContentTypes = string[] | "*";

HMPLDisallowedTag

type HMPLDisallowedTag = "script" | "style" | "iframe";

HMPLDisallowedTags

type HMPLDisallowedTags = HMPLDisallowedTag[];

HMPLSanitize

type HMPLSanitize = boolean;

HMPLIndicator

interface HMPLIndicator {
  trigger: HMPLIndicatorTrigger;
  content: string;
}

HMPLHeadersInit

interface HMPLHeadersInit {
  [key: string]: string;
}

HMPLIdentificationRequestInit

interface HMPLIdentificationRequestInit {
  value: HMPLRequestInit | HMPLRequestInitFunction;
  id: string | number;
}

HMPLRequestInitFunction

type HMPLRequestInitFunction = (
  context: HMPLInstanceContext
) => HMPLRequestInit;