From b57b5f955ee858d0e79f25992d5af323d2cd7287 Mon Sep 17 00:00:00 2001 From: Matthew Horsfall Date: Tue, 4 Dec 2018 12:11:35 -0500 Subject: [PATCH] Add some basic documentation --- lib/JMAP/Tester/WebSocket.pm | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/lib/JMAP/Tester/WebSocket.pm b/lib/JMAP/Tester/WebSocket.pm index a8b335d..635819b 100644 --- a/lib/JMAP/Tester/WebSocket.pm +++ b/lib/JMAP/Tester/WebSocket.pm @@ -199,3 +199,29 @@ sub _jresponse_from_wsresponse { } 1; +__END__ + +=head1 SYNOPSIS + + use JMAP::Tester::WebSocket; + + my $jtest = JMAP::Tester::WebSocket->new({ + ws_uri => 'ws://jmap.local/account/123', + }); + + my $response = $jtest->request([ + [ getMailboxes => {} ], + [ getMessageUpdates => { sinceState => "123" } ], + ]); + +=head1 DESCRIPTION + +This module provides a WebSockets wrapper around L. + +See L for more information. + +=head1 SEE ALSO + +L - a JMAP client made for testing JMAP servers + +=cut