fix(RAMF): Break up validate() method into two types (overloading) (#…

…498)
relaycorp · Aug 3, 2022 · 3049bbb · 3049bbb
1 parent 7048cfe
commit 3049bbb
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/src/lib/messages/RAMFMessage.ts b/src/lib/messages/RAMFMessage.ts
@@ -103,10 +103,18 @@ export default abstract class RAMFMessage<Payload extends PayloadPlaintext> {
   /**
    * Report whether the message is valid.
    *
-   * @param trustedCertificates? If present, will check that the sender is authorized to send
-   *   the message based on the trusted certificates.
-   * @return The certification path from the sender to one of the `trustedCertificates` (if present)
+   * This doesn't check whether the sender is authorised.
    */
+  public async validate(): Promise<null>;
+  /**
+   * Report whether the message is valid and the sender was authorised by one of the
+   * `trustedCertificates`.
+   *
+   * @return The certification path from the sender to one of the `trustedCertificates`
+   */
+  public async validate(
+    trustedCertificates: readonly Certificate[],
+  ): Promise<readonly Certificate[]>;
   public async validate(
     trustedCertificates?: readonly Certificate[],
   ): Promise<readonly Certificate[] | null> {