Back to Partytown

Api

src/integration/api.md

0.13.22.5 KB
Original Source

API Report File for "@qwik.dev/partytown-integration"

Do not edit this file. It is a report generated by API Extractor.

ts

// Warning: (ae-forgotten-export) The symbol "ApplyHookOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type ApplyHook = (opts: ApplyHookOptions) => any;

// Warning: (ae-forgotten-export) The symbol "GetHookOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type GetHook = (opts: GetHookOptions) => any;

// @public
export interface PartytownConfig {
    allowXhrCredentials?: boolean;
    // (undocumented)
    apply?: ApplyHook;
    debug?: boolean;
    fallbackTimeout?: number;
    forward?: PartytownForwardProperty[];
    // (undocumented)
    get?: GetHook;
    globalFns?: string[];
    lib?: string;
    loadScriptsOnMainThread?: (string | RegExp)[];
    logCalls?: boolean;
    logGetters?: boolean;
    logImageRequests?: boolean;
    logMainAccess?: boolean;
    logScriptExecution?: boolean;
    logSendBeaconRequests?: boolean;
    logSetters?: boolean;
    logStackTraces?: boolean;
    // (undocumented)
    mainWindowAccessors?: string[];
    nonce?: string;
    // Warning: (ae-forgotten-export) The symbol "SendBeaconParameters" needs to be exported by the entry point index.d.ts
    resolveSendBeaconRequestParameters?(url: URL, location: Location): SendBeaconParameters | undefined | null;
    resolveUrl?(url: URL, location: Location, type: ResolveUrlType): URL | undefined | null;
    sandboxParent?: string;
    // (undocumented)
    set?: SetHook;
    swPath?: string;
}

// @public
export type PartytownForwardProperty = string | PartytownForwardPropertyWithSettings;

// @public (undocumented)
export type PartytownForwardPropertySettings = {
    preserveBehavior?: boolean;
};

// @public (undocumented)
export type PartytownForwardPropertyWithSettings = [string, PartytownForwardPropertySettings?];

// @public
export const partytownSnippet: (config?: PartytownConfig) => string;

// @public (undocumented)
export type ResolveUrlType = 'fetch' | 'xhr' | 'script' | 'iframe' | 'image';

// @public
export const SCRIPT_TYPE = "text/partytown";

// Warning: (ae-forgotten-export) The symbol "SetHookOptions" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export type SetHook = (opts: SetHookOptions) => any;

// (No @packageDocumentation comment for this package)