argon/typings/argon.types.d.ts

Argon framework provides set of tools to build front-end applications for AEM

declare class Selector {
    constructor(selectorRef: string | Node | NodeList[] | HTMLCollection[] | Selector, createMode?: boolean);
    length: number;
    add(selector: Selector): Selector;
    attr(key: string | object, value?: string): Selector | string;
    data(key: string | object, value?: string): Selector | string;
    find(selectorRef: string | Selector): Selector;
    each(callback: Function): Selector;
    map(callback: Function): Selector[];
    clone(): Selector;
    filter(callback: Function): Selector;
    contains(selectorRef: string | Selector): Selector;
    has(selectorRef: string | Selector): Selector;
    children(): Selector;
    detach(): Selector;
    prepend(domString: string | Selector): Selector;
    append(domString: string | Selector): Selector;
    on(eventName: string, selector?: string | Selector, data?: object, callback?: Function, useCapture?: boolean): Selector;
    trigger(eventName: string, data?: any[]): Selector;
}

declare class DocumentSelector extends Selector {
    ready(callback: Function): DocumentSelector;
    readyState(): string;
}

declare function $(selectorRef: string | Selector | Node | NodeList[] | HTMLCollection[]): Selector | DocumentSelector;

declare class Render {
    constructor(templates: Function[]);
    fn(options: RenderOptions): Promise<any>;
    get(templateName: string): Function;
}

declare interface RenderOptions {
    template: string;
    target: string | Selector;
    data?: any;
    url?: string | object | string[] | object[];
}

declare class Core {
    static init(currentRoot: Selector, bundleImport: Function): void;
}

declare class Component {
    init(): void;
    doInit(root?: Node, parent?: Node): void;
    render(): string | Promise<any>;
    doDestroy(): void;
}

declare interface RouteList {
    route: string;
    component: string;
}

declare interface RouterOptions {
    route: string;
    replaceMode?: boolean;
    noTrigger?: boolean;
    queryString?: string;
    data?: object;
    appendQuery?: boolean;
    title?: string;
}

declare class Router {
    constructor(routeList: RouteList[], hashMode?: boolean);
    navigate(route: string | RouterOptions, replaceMode?: boolean, noTrigger?: boolean): Router;
    subscribe(fn: Function): Router;
}

declare function router(routeList: RouteList[], hashMode?: boolean): Router;

export { Component, Render, Core, $, router };