UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

113 lines (55 loc) 1.74 kB
--- lang: en title: 'API docs: rest.parseoperationargs' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest permalink: /doc/en/lb4/apidocs.rest.parseoperationargs.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [parseOperationArgs](./rest.parseoperationargs.md) ## parseOperationArgs() function Parses the request to derive arguments to be passed in for the Application controller method **Signature:** ```typescript export declare function parseOperationArgs(request: Request, route: ResolvedRoute, requestBodyParser?: RequestBodyParser, options?: ValidationOptions): Promise<OperationArgs>; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> request </td><td markdown="1"> Request </td><td markdown="1"> Incoming HTTP request </td></tr> <tr><td markdown="1"> route </td><td markdown="1"> [ResolvedRoute](./rest.resolvedroute.md) </td><td markdown="1"> Resolved Route </td></tr> <tr><td markdown="1"> requestBodyParser </td><td markdown="1"> [RequestBodyParser](./rest.requestbodyparser.md) </td><td markdown="1"> _(Optional)_ </td></tr> <tr><td markdown="1"> options </td><td markdown="1"> [ValidationOptions](./rest.validationoptions.md) </td><td markdown="1"> _(Optional)_ </td></tr> </tbody></table> **Returns:** Promise&lt;[OperationArgs](./rest.operationargs.md)<!-- -->&gt;