Skip to content

Commit

Permalink
Clarify flags parameter usage for server method functions
Browse files Browse the repository at this point in the history
  • Loading branch information
adamhamlin committed Dec 4, 2018
1 parent 13f417d commit 10ae669
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion API.md
Original file line number Diff line number Diff line change
Expand Up @@ -2269,7 +2269,9 @@ Registers a [server method](#server.methods) where:

- `method` - the method function with a signature `async function(...args, [flags])` where:
- `...args` - the method function arguments (can be any number of arguments or none).
- `flags` - when caching is enabled, an object used to set optional method result flags:
- `flags` - when caching is enabled, an object used to set optional method result flags. This
parameter is provided automatically and can only be accessed/modified within the method
function. It cannot be passed as an argument.
- `ttl` - `0` if result is valid but cannot be cached. Defaults to cache policy.

- `options` - (optional) configuration object:
Expand Down

0 comments on commit 10ae669

Please sign in to comment.