summaryrefslogtreecommitdiff
path: root/classes/SignalCLIError.ts
diff options
context:
space:
mode:
Diffstat (limited to 'classes/SignalCLIError.ts')
-rw-r--r--classes/SignalCLIError.ts16
1 files changed, 16 insertions, 0 deletions
diff --git a/classes/SignalCLIError.ts b/classes/SignalCLIError.ts
index 2865b75..d805dc1 100644
--- a/classes/SignalCLIError.ts
+++ b/classes/SignalCLIError.ts
@@ -1,7 +1,23 @@
+/**
+ * An error in signal-cli
+ */
export class SignalCLIError extends Error {
+ /**
+ * Full path to the signal-cli executable
+ */
public executable: string;
+
+ /**
+ * List of all the command parameters used with signal-cli
+ */
public arguments: string[];
+ /**
+ * @param message - The error message
+ * @param executable - The full path to the signal-cli executable
+ * @param args - The list of all the command parameters used with signal-cli
+ * @internal
+ */
constructor(message: string, executable?: string, args?: string[]) {
super(message);
this.name = "SignalCLIError";