Common middlewares for syncano.
\nfunctionChecks if request is allowed based on request method.
\nObjectChecks if user is logged in, returning response with 403 and message if not.
\nfunctionParses args in GET request as json if possible. If not, leaves them unchanged.
\nObjectReplace all buffers in socket args.
\nObjectRoot account check middleware.
\nAttempts to cast certain fields in request to bool.\nCan be useful to handling both GET and POST input on endpoint\nas GET endpoints will always have a string.
\nFields that are either true or 'true' will evaluate to true.\nEverything else will be considered false.
Attempts to cast certain fields in request to number.\nCan be useful to handling both GET and POST input on endpoint\nas GET endpoints will always have a string.
\nfunction\nChecks if request is allowed based on request method.\n\n**Kind**: global function \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function \\| Object | Either next function in chain or object with `key: value` pairs of method and handler function for method type. |\n| allowed | Array | List of allowed methods in case of fn being function. Optional. |\n\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {allowedMethods} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: `Hello, ${ctx.meta.user.username}`)\n}\n\nexport default ctx => serve(ctx, allowedMethods(hello, ['GET']))\n```\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {allowedMethods} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: `Hello, ${ctx.meta.user.username}`)\n}\n\nexport default ctx => serve(ctx, allowedMethods({\n GET: hello,\n POST: hello\n}))\n```\n\n\n## loggedIn(fn, opts) ⇒ Object\nChecks if user is logged in, returning response with 403 and message if not.\n\n**Kind**: global function \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Next function in request chain |\n| opts | Object | Additional options. Optional |\n| opts.message | String | Alternative message if user is not logged in. |\n\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {loggedIn} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: `Hello, ${ctx.meta.user.username}`)\n}\n\nexport default ctx => serve(ctx, loggedIn(hello))\n```\n\n\n## parseGETFields(fn) ⇒ function\nParses args in GET request as json if possible. If not, leaves them unchanged.\n\n**Kind**: global function \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Next function in request chain |\n\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {parseGETFields} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: `Hello, ${ctx.meta.user.username}`)\n}\n\nexport default ctx => serve(ctx, parseGETFields(hello))\n```\n\n\n## replaceBuffers(fn, opts) ⇒ Object\nReplace all buffers in socket args.\n\n**Kind**: global function \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Handler function |\n| opts | Object | Aditional opts. Optional |\n| opts.replaceFn | function | If set, will be used to replace buffer contents instead of default behaviour. |\n| opts.exclude | Array | List of args to skip from replacing. |\n| opts.encoding | String | Input encoding of buffer in args. |\n| opts.inputEncoding | String | Output encoding of buffer in args. Unless, replaceFn was set, this middleware replaces all buffers with it's string content in place. Modifies ctx.args. |\n\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {replaceBuffers} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: 'ok'})\n}\n\nexport default ctx => serve(ctx, replaceBuffers(hello))\n```\n\n\n## rootAccount(fn, opts) ⇒ Object\nRoot account check middleware.\n\n**Kind**: global function \n**Access**: public \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Next function in chain. |\n| opts | Object | Additional options. Optional. |\n| opts.message | String | Custom error message if not root account. |\n| opts.condFn | function | Check for root only if function evaluates to true. |\n\n**Example** \n```javascript\nimport serve, {response} from '@aexol/syncano-middleware'\nimport {rootAccount} from '@aexol/syncano-middleware-common'\n\nasync function hello(ctx, syncano) {\n return response.success({message: `Hello, ${ctx.meta.admin.email}`)\n}\n\nexport default ctx => serve(ctx, rootAccount(hello))\n```\n\n\n## toBool(fn, fields)\nAttempts to cast certain fields in request to bool.\nCan be useful to handling both GET and POST input on endpoint\nas GET endpoints will always have a string.\n\nFields that are either `true` or `'true'` will evaluate to true.\nEverything else will be considered false.\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Next function in chain |\n| fields | Array | fields to cast to bool |\n\n\n\n## toNumber(fn, fields)\nAttempts to cast certain fields in request to number.\nCan be useful to handling both GET and POST input on endpoint\nas GET endpoints will always have a string.\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | function | Next function in chain |\n| fields | Array | fields to cast to number |\n\n","readmeFilename":"README.md"}