dnrops
/
cryptpad
mirror of https://github.com/xwiki-labs/cryptpad
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add removeChannel documentation to storage/README

This commit is contained in:
ansuz 2016-05-14 13:50:25 +02:00
parent 62dba6de7b
commit 9c15a43268
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
storage/README.md
View File

@ -42,6 +42,12 @@ This function accepts the name of the channel in which the user is interested, t
It is only implemented within the leveldb adaptor, making our latest code incompatible with the other back ends. It is only implemented within the leveldb adaptor, making our latest code incompatible with the other back ends.
While we migrate to our new Netflux API, only the leveldb adaptor will be supported. While we migrate to our new Netflux API, only the leveldb adaptor will be supported.
## removeChannel(channelName, callback)
This method is called (optionally, see config.js.dist for more info) some amount of time after the last client in a channel disconnects.
It should remove any history of that channel, and execute a callback which takes an error message as an argument.
## Documenting your adaptor ## Documenting your adaptor
Naturally, you should comment your code well before making a PR. Naturally, you should comment your code well before making a PR.