From 5201fcf5bcea2f1c5c9fc0e6e97f167d78b0476e Mon Sep 17 00:00:00 2001 From: Jeremy Gunawan <jggunawa@amazon.com> Date: Thu, 19 Oct 2023 10:37:20 -0700 Subject: [PATCH] Adjust comment for correlationId --- src/SignalingClient.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/SignalingClient.ts b/src/SignalingClient.ts index 736ff9a..cd7a14c 100644 --- a/src/SignalingClient.ts +++ b/src/SignalingClient.ts @@ -357,7 +357,7 @@ export class SignalingClient extends EventEmitter { } /** - * Throws an error if the recipient client id is null and the current role is 'MASTER' as all messages sent as 'MASTER' should have a recipient client id. + * Throws an error if the correlationId does not fit the constraints mentioned in {@link https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/kvswebrtc-websocket-apis4.html the documentation}. */ private validateCorrelationId(correlationId?: string): void { if (correlationId && !/^[a-zA-Z0-9_.-]{1,256}$/.test(correlationId)) {