@iobroker/adapter-core/build/esm/controllerTools.d.ts

Core module to be used in ioBroker adapters. Acts as the bridge to js-controller.

import { isListenAllAddress, isLocalAddress, pattern2RegEx } from './tools.js';
import type { tools as ControllerToolsNamespace } from '@iobroker/js-controller-common-db';
export declare let controllerCommonModulesInternal: any;
/** The collection of utility functions in JS-Controller, formerly `lib/tools.js` */
export declare const controllerToolsInternal: typeof ControllerToolsNamespace;
/**
 * Resolve a module that is either exported by \@iobroker/js-controller-common (new controllers) or located in the controller's `lib` directory (old controllers).
 *
 * Since the resolved shape depends on `name` (e.g. `password`, `session`, `zipFiles`, `exitCodes`),
 * this is generic: callers may specify the expected type, otherwise it defaults to `any` for backwards
 * compatibility. Example: `resolveNamedModule<typeof import('...').password>('password')`.
 *
 * @template T - The expected type of the resolved module. Defaults to `any`.
 * @param name - The filename of the module to resolve
 * @param exportName - The name under which the module may be exported. Defaults to `name`.
 * @returns The resolved module, typed as `T`
 */
export declare function resolveNamedModule<T = any>(name: 'exitCodes' | 'password' | 'session' | 'zipFiles', exportName?: string): T;
/**
 * Finds the adapter directory of a given adapter
 *
 * @param adapter name of the adapter, e.g., `hm-rpc`
 * @returns path to adapter directory or null if no directory found
 */
declare function getAdapterDir(adapter: string): string | null;
/** Information about Host */
export interface InstalledInfo {
    /** If it is the js-controller */
    controller?: boolean;
    /** Version of adapter */
    version?: string;
    /** Path to adapter icon */
    icon?: string;
    /** Title of adapter */
    title?: string;
    /** I18n title of adapter */
    titleLang?: ioBroker.Translated;
    /** I18n adapter description */
    desc?: ioBroker.Translated;
    /** Supported adapter platform */
    platform?: string;
    /** The keywords */
    keywords?: string[];
    /** Path to ReadMe */
    readme?: string;
    /** Running version of adapter */
    runningVersion?: string;
    /** The license */
    license?: string;
    /** The url of the license */
    licenseUrl?: string;
}
/**
 * Get a list of all installed adapters and controller version on this host
 *
 * @param hostJsControllerVersion Version of the running js-controller, will be included in the returned information if provided
 * @returns object containing information about installed host
 */
declare function getInstalledInfo(hostJsControllerVersion?: string): Record<string, InstalledInfo>;
/**
 * Checks if we are running inside a docker container
 */
declare function isDocker(): boolean;
/**
 * Retrieve the localhost address according to the configured DNS resolution strategy
 */
declare function getLocalAddress(): '127.0.0.1' | '::1';
/**
 * Get the ip to listen to all addresses according to configured DNS resolution strategy
 */
declare function getListenAllAddress(): '0.0.0.0' | '::';
export declare const commonTools: {
    pattern2RegEx: typeof pattern2RegEx;
    getAdapterDir: typeof getAdapterDir;
    getInstalledInfo: typeof getInstalledInfo;
    isDocker: typeof isDocker;
    getLocalAddress: typeof getLocalAddress;
    getListenAllAddress: typeof getListenAllAddress;
    isLocalAddress: typeof isLocalAddress;
    isListenAllAddress: typeof isListenAllAddress;
    password: any;
    session: any;
    zipFiles: any;
};
export {};