RequestParser Class
Packages > @fluidframework/runtime-utils > RequestParser
The Request Parser takes an IRequest provides parsing and sub request creation
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/runtime-utils/legacy.
For more information about our API support guarantees, see here .
Signature
export declare class RequestParser implements IRequest
Implements: IRequest
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(request) | Alpha |
Constructs a new instance of the RequestParser class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| headers | Alpha |
optional, readonly |
IRequestHeader | |
| pathParts | Alpha |
readonly |
readonly string[] | Returns the decoded path parts of the request's url |
| query | Alpha |
readonly |
string | |
| url | Alpha |
readonly |
string |
Constructor Details
(constructor)
Constructs a new instance of the RequestParser class
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-utils/alpha.
For more information about our API support guarantees, see here .
Signature
protected constructor(request: Readonly<IRequest>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| request | Readonly<IRequest> |
Property Details
headers
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-utils/alpha.
For more information about our API support guarantees, see here .
Signature
readonly headers?: IRequestHeader;
Type: IRequestHeader
pathParts
Returns the decoded path parts of the request’s url
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-utils/alpha.
For more information about our API support guarantees, see here .
Signature
get pathParts(): readonly string[];
Type: readonly string[]
query
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-utils/alpha.
For more information about our API support guarantees, see here .
Signature
readonly query: string;
Type: string
url
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-utils/alpha.
For more information about our API support guarantees, see here .
Signature
get url(): string;
Type: string