iproutejs 2.3.0

package/lib/commands/maddress/add.schema.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaddressAddSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+exports.MaddressAddSchema = {
+    $id: schemas_1.SchemaIds.MaddressAdd,
+    type: 'object',
+    required: ['address', 'dev'],
+    properties: {
+        address: {
+            type: 'string',
+            minLength: 1,
+            format: 'mac',
+            keyless: true
+        },
+        dev: {
+            type: 'string',
+            minLength: 1
+        }
+    }
+};
+//# sourceMappingURL=add.schema.js.map

package/lib/commands/maddress/add.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.schema.js","sourceRoot":"","sources":["../../../src/commands/maddress/add.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAG9C,QAAA,iBAAiB,GAAuC;IACnE,GAAG,EAAS,mBAAS,CAAC,WAAW;IACjC,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,SAAS,EAAE,KAAK,CAAC;IAC9B,UAAU,EAAE;QACV,OAAO,EAAE;YACP,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,MAAM,EAAK,KAAK;YAChB,OAAO,EAAI,IAAI;SAChB;QACD,GAAG,EAAM;YACP,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;SACb;KACF;CACF,CAAC"}

package/lib/commands/maddress/show.interfaces.d.ts

@@ -0,0 +1,25 @@
+import { AddressFamilies } from '../address.constants';
+/**
+ * Maddress show options.
+ * @category Interfaces
+ */
+export interface MaddressShowOptions {
+    /** The device to join/leave this multicast address. */
+    dev?: string;
+}
+/**
+ * Maddress Info.
+ * TODO: Need help to build this undocumented & comprehensive interface.
+ *
+ * @category Interfaces
+ */
+export interface MaddressInfo {
+    ifindex: number;
+    ifname: string;
+    maddr: Array<{
+        family?: AddressFamilies;
+        address?: string;
+        link?: string;
+        users?: number;
+    }>;
+}

package/lib/commands/maddress/show.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=show.interfaces.js.map

package/lib/commands/maddress/show.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.interfaces.js","sourceRoot":"","sources":["../../../src/commands/maddress/show.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/maddress/show.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { MaddressShowOptions } from './show.interfaces';
+export declare const MaddressShowSchema: JSONSchemaType<MaddressShowOptions>;

package/lib/commands/maddress/show.schema.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaddressShowSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+exports.MaddressShowSchema = {
+    $id: schemas_1.SchemaIds.MaddressShow,
+    type: 'object',
+    required: [],
+    properties: {
+        dev: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=show.schema.js.map

package/lib/commands/maddress/show.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.schema.js","sourceRoot":"","sources":["../../../src/commands/maddress/show.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAG9C,QAAA,kBAAkB,GAAwC;IACrE,GAAG,EAAS,mBAAS,CAAC,YAAY;IAClC,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAE;QACV,GAAG,EAAE;YACH,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;KACF;CACF,CAAC"}

package/lib/commands/maddress.d.ts

@@ -0,0 +1,82 @@
+import Command from '../common/classes/command';
+import { GlobalOptions } from '../common/interfaces/common';
+import { MaddressAddOptions } from './maddress/add.interfaces';
+import { MaddressInfo, MaddressShowOptions } from './maddress/show.interfaces';
+/**
+ * Add a multicast address.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Add a multicast address
+ * ```
+ * await maddress.add({
+ *   address: '33:33:00:00:00:01',
+ *   dev: 'enp0s3'
+ * });
+ * ```
+ */
+export declare function add(options: MaddressAddOptions, globalOptions?: GlobalOptions): Promise<Command<MaddressAddOptions>>;
+/**
+ * Delete a multicast address.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Delete a tunnel
+ * ```
+ * await maddress.del({
+ *   address: '33:33:00:00:00:01',
+ *   dev: 'enp0s3'
+ * });
+ * ```
+ */
+export declare function del(options: MaddressAddOptions, globalOptions?: GlobalOptions): Promise<Command<MaddressAddOptions>>;
+/**
+ * List multicast addresses.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Show multicast addresses
+ * ```
+ * const entries = await maddress.show({});
+ * ```
+ */
+export declare function show(options: MaddressShowOptions, globalOptions?: GlobalOptions): Promise<Command<MaddressShowOptions> | MaddressInfo[]>;
+declare const _default: {
+    add: typeof add;
+    del: typeof del;
+    show: typeof show;
+};
+export default _default;

package/lib/commands/maddress.js

@@ -0,0 +1,121 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.show = exports.del = exports.add = void 0;
+const command_with_returned_data_1 = __importDefault(require("../common/classes/command-with-returned-data"));
+const command_1 = __importDefault(require("../common/classes/command"));
+const schemas_1 = require("../common/constants/schemas");
+const add_schema_1 = require("./maddress/add.schema");
+const show_schema_1 = require("./maddress/show.schema");
+/**
+ * Add a multicast address.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Add a multicast address
+ * ```
+ * await maddress.add({
+ *   address: '33:33:00:00:00:01',
+ *   dev: 'enp0s3'
+ * });
+ * ```
+ */
+function add(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'maddress', 'add'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.MaddressAdd, add_schema_1.MaddressAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.add = add;
+/**
+ * Delete a multicast address.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Delete a tunnel
+ * ```
+ * await maddress.del({
+ *   address: '33:33:00:00:00:01',
+ *   dev: 'enp0s3'
+ * });
+ * ```
+ */
+function del(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'maddress', 'del'];
+        const ipCmd = new command_1.default(schemas_1.SchemaIds.MaddressAdd, add_schema_1.MaddressAddSchema, options, globalOptions, cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.del = del;
+/**
+ * List multicast addresses.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { maddress } from 'iproutejs';
+ * ```
+ *
+ * Show multicast addresses
+ * ```
+ * const entries = await maddress.show({});
+ * ```
+ */
+function show(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'maddress', 'show'];
+        const ipCmd = new command_with_returned_data_1.default(schemas_1.SchemaIds.MaddressShow, show_schema_1.MaddressShowSchema, options, Object.assign(Object.assign({}, globalOptions), { 
+            // Overrides for a better show.
+            '-details': true, '-statistics': true, '-json': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.show = show;
+exports.default = {
+    add,
+    del,
+    show
+};
+//# sourceMappingURL=maddress.js.map

package/lib/commands/maddress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maddress.js","sourceRoot":"","sources":["../../src/commands/maddress.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,8GAAmF;AACnF,wEAAgD;AAChD,yDAAwD;AAGxD,sDAA0D;AAE1D,wDAA4D;AAE5D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAsB,GAAG,CAAC,OAA2B,EAC3B,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,WAAW,EACrB,8BAAiB,EACjB,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAsB,GAAG,CAAC,OAA2B,EAC3B,gBAA+B,EAAE;;QAEzD,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QAEtC,MAAM,KAAK,GAAG,IAAI,iBAAO,CACvB,mBAAS,CAAC,WAAW,EACrB,8BAAiB,EACjB,OAAO,EACP,aAAa,EACb,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAbD,kBAaC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAsB,IAAI,CAAC,OAA4B,EAC5B,gBAA+B,EAAE;;QAE1D,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAEvC,MAAM,KAAK,GAAG,IAAI,oCAAuB,CACvC,mBAAS,CAAC,YAAY,EACtB,gCAAkB,EAClB,OAAO,kCAEF,aAAa;YAChB,+BAA+B;YAC/B,UAAU,EAAK,IAAI,EACnB,aAAa,EAAE,IAAI,EACnB,OAAO,EAAQ,IAAI,KAErB,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAkB,CAAC;IAC5C,CAAC;CAAA;AAnBD,oBAmBC;AAED,kBAAe;IACb,GAAG;IACH,GAAG;IACH,IAAI;CACL,CAAC"}

package/lib/commands/monitor/monitor.interfaces.d.ts

@@ -0,0 +1,24 @@
+import { MonitorObjects } from '../monitor.constants';
+/**
+ * Monitor options.
+ * @category Interfaces
+ */
+export interface MonitorOptions {
+    /** Object type to monitor. */
+    object: MonitorObjects;
+    /**
+     * If set, a prefix is displayed before each message to show the family of the message.
+     * For `monitor`, is always enforced internally for consistency.
+     */
+    label?: true;
+    /**
+     * If set, the program listens to all network namespaces that have a `nsid` assigned into the network namespace
+     * where the program is running.
+     *
+     * A prefix is displayed to show the network namespace where the message originates.
+     * For `monitor`, is always enforced internally for consistency.
+     */
+    'all-nsid'?: true;
+    /** Prints only events related to this device. */
+    dev?: string;
+}

package/lib/commands/monitor/monitor.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=monitor.interfaces.js.map

package/lib/commands/monitor/monitor.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.interfaces.js","sourceRoot":"","sources":["../../../src/commands/monitor/monitor.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/monitor/monitor.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { MonitorOptions } from './monitor.interfaces';
+export declare const MonitorSchema: JSONSchemaType<MonitorOptions>;

package/lib/commands/monitor/monitor.schema.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MonitorSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const monitor_constants_1 = require("../monitor.constants");
+exports.MonitorSchema = {
+    $id: schemas_1.SchemaIds.Monitor,
+    type: 'object',
+    required: ['object'],
+    properties: {
+        object: {
+            type: 'string',
+            enum: Object.values(monitor_constants_1.MonitorObjects),
+            keyless: true
+        },
+        label: {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        'all-nsid': {
+            type: 'boolean',
+            enum: [true],
+            nullable: true
+        },
+        dev: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        }
+    }
+};
+//# sourceMappingURL=monitor.schema.js.map

package/lib/commands/monitor/monitor.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.schema.js","sourceRoot":"","sources":["../../../src/commands/monitor/monitor.schema.ts"],"names":[],"mappings":";;;AAGA,4DAA2D;AAC3D,4DAAsD;AAEzC,QAAA,aAAa,GAAmC;IAC3D,GAAG,EAAS,mBAAS,CAAC,OAAO;IAC7B,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,CAAC,QAAQ,CAAC;IACtB,UAAU,EAAE;QACV,MAAM,EAAM;YACV,IAAI,EAAK,QAAQ;YACjB,IAAI,EAAK,MAAM,CAAC,MAAM,CAAC,kCAAc,CAAqB;YAC1D,OAAO,EAAE,IAAI;SACd;QACD,KAAK,EAAO;YACV,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAE;YACV,IAAI,EAAM,SAAS;YACnB,IAAI,EAAM,CAAC,IAAI,CAAC;YAChB,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAS;YACV,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;KACF;CACF,CAAC"}

package/lib/commands/monitor.constants.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Monitor objects.
+ * @category Constants
+ */
+export declare enum MonitorObjects {
+    All = "all",
+    Link = "link",
+    Address = "address",
+    Route = "route",
+    Mroute = "mroute",
+    Prefix = "prefix",
+    Neigh = "neigh",
+    Netconf = "netconf",
+    Rule = "rule",
+    Nsid = "nsid",
+    Nexthop = "nexthop"
+}

package/lib/commands/monitor.constants.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MonitorObjects = void 0;
+/**
+ * Monitor objects.
+ * @category Constants
+ */
+var MonitorObjects;
+(function (MonitorObjects) {
+    MonitorObjects["All"] = "all";
+    MonitorObjects["Link"] = "link";
+    MonitorObjects["Address"] = "address";
+    MonitorObjects["Route"] = "route";
+    MonitorObjects["Mroute"] = "mroute";
+    MonitorObjects["Prefix"] = "prefix";
+    MonitorObjects["Neigh"] = "neigh";
+    MonitorObjects["Netconf"] = "netconf";
+    MonitorObjects["Rule"] = "rule";
+    MonitorObjects["Nsid"] = "nsid";
+    MonitorObjects["Nexthop"] = "nexthop";
+})(MonitorObjects || (exports.MonitorObjects = MonitorObjects = {}));
+//# sourceMappingURL=monitor.constants.js.map

package/lib/commands/monitor.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.constants.js","sourceRoot":"","sources":["../../src/commands/monitor.constants.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,cAYX;AAZD,WAAY,cAAc;IACxB,6BAAe,CAAA;IACf,+BAAgB,CAAA;IAChB,qCAAmB,CAAA;IACnB,iCAAiB,CAAA;IACjB,mCAAkB,CAAA;IAClB,mCAAkB,CAAA;IAClB,iCAAiB,CAAA;IACjB,qCAAmB,CAAA;IACnB,+BAAgB,CAAA;IAChB,+BAAgB,CAAA;IAChB,qCAAmB,CAAA;AACrB,CAAC,EAZW,cAAc,8BAAd,cAAc,QAYzB"}

package/lib/commands/monitor.d.ts

@@ -0,0 +1,52 @@
+import MonitorCommand from '../common/classes/monitor-command';
+import { GlobalOptions } from '../common/interfaces/common';
+import { MonitorOptions } from './monitor/monitor.interfaces';
+/**
+ * State monitoring.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { monitor } from 'iproutejs';
+ * ```
+ *
+ * Monitor all objects state changes
+ * ```
+ * monitor({
+ *   object: MonitorObjects.All
+ * });
+ * ```
+ *
+ * After starting the monitor, you can start watching for changes
+ * ```
+ * let command: MonitorCommand<MonitorOptions>;
+ *
+ * monitor({
+ *   object: MonitorObjects.All
+ * })
+ * .then((_command) => {
+ *   command = _command;
+ *
+ *   command.on(MonitorObjects.All, (data: MonitorEmittedData) => {
+ *     // Do something with `data`.
+ *   });
+ *
+ *   command.on('error', (error) => {
+ *     // Do something with `data`.
+ *   });
+ * });
+ *
+ * setTimeout(() => {
+ *   command.close();
+ * }, 5000);
+ * ```
+ */
+export declare function monitor(options: MonitorOptions, globalOptions?: GlobalOptions): Promise<MonitorCommand<MonitorOptions>>;
+export default monitor;

package/lib/commands/monitor.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.monitor = void 0;
+const monitor_command_1 = __importDefault(require("../common/classes/monitor-command"));
+const schemas_1 = require("../common/constants/schemas");
+const monitor_schema_1 = require("./monitor/monitor.schema");
+/**
+ * State monitoring.
+ *
+ * @param options        - Parameters options to be passed down to `ip`.
+ * @param globalOptions  - Global parameters options that affects the command execution.
+ *
+ * @throws {@link ParametersError} - Throws when passed parameters are invalid.
+ * @throws {@link CommandError}    - Throws when the executed command fails.
+ *
+ * @example
+ *
+ * Import module
+ * ```
+ * import { monitor } from 'iproutejs';
+ * ```
+ *
+ * Monitor all objects state changes
+ * ```
+ * monitor({
+ *   object: MonitorObjects.All
+ * });
+ * ```
+ *
+ * After starting the monitor, you can start watching for changes
+ * ```
+ * let command: MonitorCommand<MonitorOptions>;
+ *
+ * monitor({
+ *   object: MonitorObjects.All
+ * })
+ * .then((_command) => {
+ *   command = _command;
+ *
+ *   command.on(MonitorObjects.All, (data: MonitorEmittedData) => {
+ *     // Do something with `data`.
+ *   });
+ *
+ *   command.on('error', (error) => {
+ *     // Do something with `data`.
+ *   });
+ * });
+ *
+ * setTimeout(() => {
+ *   command.close();
+ * }, 5000);
+ * ```
+ */
+function monitor(options, globalOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = ['ip', 'monitor'];
+        const ipCmd = new monitor_command_1.default(schemas_1.SchemaIds.Monitor, monitor_schema_1.MonitorSchema, options, Object.assign(Object.assign({}, globalOptions), { '-tshort': true, '-oneline': true }), cmd);
+        return yield ipCmd.exec();
+    });
+}
+exports.monitor = monitor;
+exports.default = monitor;
+//# sourceMappingURL=monitor.js.map

package/lib/commands/monitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.js","sourceRoot":"","sources":["../../src/commands/monitor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wFAA+D;AAC/D,yDAAwD;AAGxD,6DAAyD;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,SAAsB,OAAO,CAAC,OAAuB,EACvB,gBAA+B,EAAE;;QAE7D,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAE9B,MAAM,KAAK,GAAG,IAAI,yBAAc,CAC9B,mBAAS,CAAC,OAAO,EACjB,8BAAa,EACb,OAAO,kCAEF,aAAa,KAChB,SAAS,EAAG,IAAI,EAChB,UAAU,EAAE,IAAI,KAElB,GAAG,CAAC,CAAC;QAEP,OAAO,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CAAA;AAjBD,0BAiBC;AAED,kBAAe,OAAO,CAAC"}

package/lib/commands/mroute/show.interfaces.d.ts

@@ -0,0 +1,26 @@
+import { RouteRoutingTables } from '../route/show.constants';
+/**
+ * Mroute show options.
+ * @category Interfaces
+ */
+export interface MrouteShowOptions {
+    /** The prefix selecting the destination multicast addresses to list. */
+    to?: string;
+    /** The prefix selecting the IP source addresses of the multicast route. */
+    from?: string;
+    /** The interface on which multicast packets are received. */
+    iif?: string;
+    /**
+     * The table id selecting the multicast table.
+     * It can be `local`, `main`, `default`, `all` or a number.
+     */
+    table?: number | RouteRoutingTables;
+}
+/**
+ * Mroute Info.
+ * TODO: Need help to build this undocumented & comprehensive interface.
+ *
+ * @category Interfaces
+ */
+export interface MrouteInfo {
+}

package/lib/commands/mroute/show.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=show.interfaces.js.map

package/lib/commands/mroute/show.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.interfaces.js","sourceRoot":"","sources":["../../../src/commands/mroute/show.interfaces.ts"],"names":[],"mappings":""}

package/lib/commands/mroute/show.schema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from 'ajv';
+import { MrouteShowOptions } from './show.interfaces';
+export declare const MrouteShowSchema: JSONSchemaType<MrouteShowOptions>;

package/lib/commands/mroute/show.schema.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MrouteShowSchema = void 0;
+const schemas_1 = require("../../common/constants/schemas");
+const show_constants_1 = require("../route/show.constants");
+exports.MrouteShowSchema = {
+    $id: schemas_1.SchemaIds.MrouteShow,
+    type: 'object',
+    required: [],
+    properties: {
+        to: {
+            type: 'string',
+            format: 'ip-with-required-mask',
+            nullable: true
+        },
+        from: {
+            type: 'string',
+            format: 'ip-with-required-mask',
+            nullable: true
+        },
+        iif: {
+            type: 'string',
+            minLength: 1,
+            nullable: true
+        },
+        table: {
+            type: ['string', 'integer'],
+            nullable: true,
+            oneOf: [
+                {
+                    type: 'string',
+                    enum: Object.values(show_constants_1.RouteRoutingTables),
+                    nullable: true
+                },
+                {
+                    type: 'integer',
+                    minimum: 0,
+                    nullable: true
+                }
+            ]
+        }
+    }
+};
+//# sourceMappingURL=show.schema.js.map

package/lib/commands/mroute/show.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.schema.js","sourceRoot":"","sources":["../../../src/commands/mroute/show.schema.ts"],"names":[],"mappings":";;;AAEA,4DAA2D;AAE3D,4DAA6D;AAEhD,QAAA,gBAAgB,GAAsC;IACjE,GAAG,EAAS,mBAAS,CAAC,UAAU;IAChC,IAAI,EAAQ,QAAQ;IACpB,QAAQ,EAAI,EAAE;IACd,UAAU,EAAE;QACV,EAAE,EAAK;YACL,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAG;YACL,IAAI,EAAM,QAAQ;YAClB,MAAM,EAAI,uBAAuB;YACjC,QAAQ,EAAE,IAAI;SACf;QACD,GAAG,EAAI;YACL,IAAI,EAAO,QAAQ;YACnB,SAAS,EAAE,CAAC;YACZ,QAAQ,EAAG,IAAI;SAChB;QACD,KAAK,EAAE;YACL,IAAI,EAAM,CAAC,QAAQ,EAAE,SAAS,CAAC;YAC/B,QAAQ,EAAE,IAAI;YACd,KAAK,EAAK;gBACR;oBACE,IAAI,EAAM,QAAQ;oBAClB,IAAI,EAAM,MAAM,CAAC,MAAM,CAAC,mCAAkB,CAAyB;oBACnE,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAM,SAAS;oBACnB,OAAO,EAAG,CAAC;oBACX,QAAQ,EAAE,IAAI;iBACf;aACF;SACF;KACF;CACF,CAAC"}