kosmos/rs-module-chat-messages
kosmos/rs-module-chat-messages
8
0
Fork 0
Code Issues 1 Pull Requests Releases 3 Activity

Document isPublic argument as optional

Browse Source
This commit is contained in:
Basti 2021-09-13 13:17:51 +02:00
parent bf896a076c
commit 15af899e1d
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/chat-messages.js
View File

@ -158,7 +158,7 @@ const ChatMessages = function (privateClient, publicClient) {
* @param {string} options.channelName - Name of room/channel (e.g. "#kosmos") * @param {string} options.channelName - Name of room/channel (e.g. "#kosmos")
* @param {string} [options.channelType] - Type of channel ("room" or "person") * @param {string} [options.channelType] - Type of channel ("room" or "person")
* @param {date} options.date - Date of archive day * @param {date} options.date - Date of archive day
* @param {boolean} options.isPublic - Store logs in public folder (defaults to false) * @param {boolean} [options.isPublic] - Store logs in public folder (defaults to false)
* @param {string} [options.previous] - Date of previous log file as `YYYY/MM/DD`. Looked up automatically when not given * @param {string} [options.previous] - Date of previous log file as `YYYY/MM/DD`. Looked up automatically when not given
* @param {string} [options.next] - Date of next log file as `YYYY/MM/DD`. looked up automatically when not given * @param {string} [options.next] - Date of next log file as `YYYY/MM/DD`. looked up automatically when not given
* *