ChemPal Documentation - v0.0.0
    Preparing search index...

    Module types/common

    Interfaces

    SearchHistoryEntry

    Interface defining the required properties for a history entry. Used to store the history of results that were clicked on.

    ProductHistoryEntry

    Interface defining the required properties for a product history entry. Used to store the history of products that were clicked on.

    TextOptionFacet

    Represents a faceted search option with text values. Used for filtering and categorizing search results.

    CustomColumn

    Extended column interface with additional metadata support. Used to enhance TanStack Table columns with custom metadata.

    ProductRow

    Represents a row in the product table. Used for type-safe row operations in TanStack Table.

    UOMAliases

    Mapping of standard units of measurement to their various string representations. Used for normalizing unit of measurement strings from different suppliers.

    Type Aliases

    WeightUnit
    VolumeUnit
    LengthUnit
    TemperatureUnit
    PressureUnit
    TimeUnit
    AmountUnit
    WeightString
    VolumeString
    LengthString
    TemperatureString
    PressureString
    TimeUnitString
    AmountString
    QuantityString
    Awaitable

    Type that allows either a value or a Promise of that value. Used for functions that may return either synchronously or asynchronously.

    HTMLResponse

    Extended Response type specifically for HTML responses. Used for handling HTTP responses containing HTML content.

    JSONResponse

    Response type specifically for JSON responses. Used for handling HTTP responses containing JSON content.

    Maybe

    Type that represents either a non-null value of T or undefined. Used for optional values that cannot be null when present.

    MaybeArray

    Type that allows either a single value or an array of values of type T. Used for functions that may return either a single value or an array of values.

    CountryCode

    Represents a country code in ISO 3166-1 alpha-2 format. This is a two-letter code that uniquely identifies a country. Examples: "US", "GB", "DE", "FR"

    Brand

    Creates an opaque type with a type name

    ShippingRange

    Represents a shipping range type. Used to define the shipping scope of a supplier or product.

    PaymentMethod

    Represents a payment method. Used to define the payment method of a supplier or product.

    Base64String

    Represents a base64 encoded string. Used to represent binary data as a string.

    HistoryEntry