Interface Supplier

Base interface for product supplier implementation. Defines the common structure and functionality that all suppliers must implement.

Example

class MySupplier implements Supplier {
  supplierName = "MySupplier";
  query = "";
  queryResults = [];
  baseURL = "https://mysupplier.com";
  controller = new AbortController();
  limit = 10;
  httpRequestHardLimit = 50;
  headers = { "Content-Type": "application/json" };
}

interface Supplier {
    supplierName: string;
    query: string;
    queryResults: Record<string, unknown>[];
    baseURL: string;
    controller: AbortController;
    limit: number;
    httpRequestHardLimit: number;
    headers: HeadersInit;
}

Index

Properties

supplierName query queryResults baseURL controller limit httpRequestHardLimit headers

Properties

supplierName

supplierName: string

Display name of the supplier

Example: "Sigma-Aldrich"

query

query: string

Current active search query

Example: "sodium chloride"

queryResults

queryResults: Record<string, unknown>[]

Raw results from the last search query

baseURL

baseURL: string

Base URL for supplier's API endpoints

Example: "https://api.supplier.com"

controller

controller: AbortController

AbortController for canceling in-flight requests

limit

limit: number

Maximum number of results to return

Example: 10

httpRequestHardLimit

httpRequestHardLimit: number

Maximum number of concurrent HTTP requests

Example: 50

headers

headers: HeadersInit

Custom headers for API requests

Interface Supplier

Example

Index

Properties

Properties

supplierName

Example: "Sigma-Aldrich"

query

Example: "sodium chloride"

queryResults

baseURL

Example: "https://api.supplier.com"

controller

limit

Example: 10

httpRequestHardLimit

Example: 50

headers

Example: { "Authorization": "Bearer token123" }

Settings

On This Page