UNPKG

@loopback/docs

Version:

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

307 lines (137 loc) 3.8 kB
--- lang: en title: 'API docs: rest.redirectroute' 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.redirectroute.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [RedirectRoute](./rest.redirectroute.md) ## RedirectRoute class **Signature:** ```typescript export declare class RedirectRoute implements RouteEntry, ResolvedRoute ``` **Implements:** [RouteEntry](./rest.routeentry.md)<!-- -->, [ResolvedRoute](./rest.resolvedroute.md) ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(sourcePath, targetLocation, statusCode)](./rest.redirectroute._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `RedirectRoute` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [path](./rest.redirectroute.path.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> string </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [pathParams](./rest.redirectroute.pathparams.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> [PathParameterValues](./rest.pathparametervalues.md) </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [schemas](./rest.redirectroute.schemas.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> SchemasObject </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [sourcePath](./rest.redirectroute.sourcepath.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> string </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [spec](./rest.redirectroute.spec.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> OperationObject </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [statusCode](./rest.redirectroute.statuscode.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> number </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [targetLocation](./rest.redirectroute.targetlocation.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> string </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [verb](./rest.redirectroute.verb.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> string </td><td markdown="1"> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [describe()](./rest.redirectroute.describe.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [invokeHandler({ response }, input, args)](./rest.redirectroute.invokehandler.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [isRedirectRoute(obj)](./rest.redirectroute.isredirectroute.md) </td><td markdown="1"> `static` </td><td markdown="1"> type guard type checker for this class </td></tr> <tr><td markdown="1"> [updateBindings(requestContext)](./rest.redirectroute.updatebindings.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> </tbody></table>