@enonic-types/lib-vhost/vhost.d.ts

Type definitions for lib-vhost.

declare global {
    interface XpLibraries {
        '/lib/xp/vhost': typeof import('./vhost');
    }
}
export interface VirtualHosts {
    vhosts: VirtualHost[];
}
export interface IdProviderKey {
    idProviderKey: string;
}
export interface VirtualHost {
    name: string;
    source: string;
    target: string;
    host: string;
    defaultIdProviderKey?: string;
    idProviderKeys?: IdProviderKey[];
}
/**
 * Functions to find virtual host.
 *
 * @example
 * var vhostLib = require('/lib/xp/vhost');
 *
 * @module vhost
 */
/**
 * Returns value which is set for the `enabled` property in the `com.enonic.xp.web.vhost.cfg` file.
 *
 * @returns {boolean} `true` if vhost mapping is enabled, otherwise `false`.
 */
export declare function isEnabled(): boolean;
/**
 * This function returns virtual hosts.
 *
 * @returns {VirtualHosts} An object with all the virtual hosts.
 */
export declare function list(): VirtualHosts;