@viviedu/applet-sdk
    Preparing search index...

    Type Alias AppletOptions<ReqBoxFeats, ReqClientFeats>

    type AppletOptions<
        ReqBoxFeats extends
            readonly BoxAppletFeature[] = readonly BoxAppletFeature[],
        ReqClientFeats extends
            readonly ClientAppletFeature[] = readonly ClientAppletFeature[],
    > = {
        log?: boolean;
        requiredBoxFeatures?: ReqBoxFeats;
        requiredClientFeatures?: ReqClientFeats;
    }

    Type Parameters

    • ReqBoxFeats extends readonly BoxAppletFeature[] = readonly BoxAppletFeature[]
    • ReqClientFeats extends readonly ClientAppletFeature[] = readonly ClientAppletFeature[]
    Index

    Properties

    log?: boolean

    Whether the SDK should log out verbose messaging for this applet.

    requiredBoxFeatures?: ReqBoxFeats

    Box features the applet requires to function.

    Initialisation will throw if the host doesn't report all of them.

    Listing a feature here also narrows the matching method types from Method | null to Method.

    requiredClientFeatures?: ReqClientFeats

    Client features the applet requires to function.

    Initialisation will throw if the host doesn't report all of them.

    Listing a feature here also narrows the matching method types from Method | null to Method.