routeros-api/dist/RosApiMenu.d.ts

Mikrotik Routerboard RouterOS API for NodeJS

import { RosApiCommands } from "./RosApiCommands";
import { RosApiModel } from "./RosApiModel";
import { RouterOSAPI } from "./RouterOSAPI";
export declare class RosApiMenu {
    /**
     * The raw API
     */
    private rosApi;
    /**
     * Toggles snake_case mode, defaults to camelCase
     */
    private snakeCase;
    /**
     * Creates a handler for the menus
     * and creates Models
     *
     * @param rosApi The raw api
     */
    constructor(rosApi: RouterOSAPI);
    /**
     * Returns a set of operations to do over
     * the menu provided
     *
     * @param path The menu you want to do actions
     */
    menu(path: string): RosApiCommands;
    /**
     * Instead of transforming the routeros properties
     * to camelCase, transforms to snake_case
     */
    useSnakeCase(): void;
    /**
     * Creates a model of pre-made actions to do
     * with an item from any menu that has lists
     *
     * @param item The item of a menu (Ex: a single firewall rule, or an IP address)
     */
    model(item: any): RosApiModel | RosApiModel[];
}