From 9c15a43268c09b7b578b36e117c219aa2fd332a4 Mon Sep 17 00:00:00 2001 From: ansuz Date: Sat, 14 May 2016 13:50:25 +0200 Subject: [PATCH] add removeChannel documentation to storage/README --- storage/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/storage/README.md b/storage/README.md index 3c854d00c..7f406cf94 100644 --- a/storage/README.md +++ b/storage/README.md @@ -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. 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 Naturally, you should comment your code well before making a PR.