UNPKG

@push.rocks/websetup

Version:

setup basic page properties

42 lines (41 loc) 1.28 kB
import * as interfaces from './interfaces/index.js'; import { TagManager } from './websetup.classes.tagmanager.js'; import { TagLevel } from './websetup.classes.taglevel.js'; export interface IWebSetupConstructorOptions { metaObject: interfaces.IMetaObject; smartssrWaitForReadySignal?: boolean; } /** * the main WebSetup class */ export declare class WebSetup { tagManager: TagManager; options: IWebSetupConstructorOptions; private readyDeferred; private readyForSmartssrDeferred; readyPromise: Promise<unknown>; readyForSmartssrPromise: Promise<unknown>; constructor(optionsArg: IWebSetupConstructorOptions); /** * an async setup called by the constructor */ setup(optionsArg?: IWebSetupConstructorOptions): Promise<void>; /** * reverts the active level and returns to the base level */ revertToBaseLevel(): void; /** * sets a subpage * @param metaObjectArg */ setSubLevel(metaObjectArg: interfaces.IMetaObject): Promise<TagLevel>; /** * flashes the title with the given text * @param flashTextArg */ flashTitle(flashTextArg: string): void; /** * informs smartssr that the page is ready to be rendered */ informReadyForSmartssr(): void; }