Docs for some Foxx controller features

[myguidingstar-zz]

I see this in Changlog for 2.2.3

• added around for Foxx controller

but can't find the doc for that anywhere

Also, I can't find doc for the next argument which is used in https://github.com/triAGENS/ArangoDB/blob/master/js/server/modules/org/arangodb/foxx/format_middleware.js#L39

[moonglum]

@pluma Could you check together with @13abylon ?

[myguidingstar-zz]

It turns out that the doc for around can be found here https://github.com/triAGENS/ArangoDB/blob/master/js/server/modules/org/arangodb/foxx/controller.js#L410 and the official online doc, too. But it's missing in the ePub build.

[13abylon]

The doc for around is now also in the online documentation (http://docs.arangodb.org/Foxx/FoxxController.html#around).

[myguidingstar-zz]

Hi @13abylon , I'm not sure if this "return false" feature is implemented yet. Can you check the doc for that,too? #1023

---

Edited: I was looking at master branch instead of devel. It is documented. Sorry for this

[13abylon]

Great :)
So can I close this issue or do you have another question regarding the documentation?

[myguidingstar-zz]

well, about doc for around, it's not clear to see why manually call next() is necessary (hence the difference between before and around). I think another example for around's use case in comparision with before should be great. And does around react to "return false" as in before? What does the third argument opts do?
Btw, there's a typo in the 5th line at "a next funcion ..."

[pluma]

It's rather simple, really:

• before is executed before the route handler is called, returning false terminates the route handling.
• after is executed after the route handler is called.
• around is executed instead of the route handler, the route handler is passed in as the next callback.

So you could use around for things which would otherwise be a bit difficult, e.g. timing requests:

.around(function (req, res, opts, next) {
  var start = Date.now();
  next();
  var end = Date.now();
  var delta = end - start;
  console.log('Request took', delta, 'milliseconds to complete.');
})

[myguidingstar-zz]

@pluma the current doc says around accept four arguments:

(req, res, opts, next)

is it correct?

[pluma]

@myguidingstar Yes, sorry, I fixed the example.

[myguidingstar-zz]

then what does opts do, @pluma ?

[pluma]

@fceller I think you know the router internals better than me?

[13abylon]

The typo is fixed, now only @fceller needs to answer the question

[myguidingstar-zz]

An other doc issue here. In module "console" it says:

console.groupCollapsed
console.groupCollapsed(format, argument1, ...)
Same as console.group, but with the group initially collapsed.

But what does "collapsed" mean here anyway?

[razvanphp]

I found other 2 (summary and notes):
https://github.com/arangodb/arango-cms/blob/master/cms.js#L29

[moonglum]

summary and notes are internal 😄

[pluma]

@moonglum is it? The docs mention the auto-magical summary comments, though. See https://docs.arangodb.com/Foxx/Develop/Controller.html