IParsedRouteSegment interface
And individual segment of the route (fixed text or a parameter)
Properties
is |
Whether the parameter is required in order for the URL to be valid. |
is |
For parameters, whether or not this parameter is a wildcard (*) parameter, which means it allows multiple path segments (i.e. don't escape "/") |
param |
If present, the name of the route value parameter to substitute for this segment. Either text or paramName will be defined for a segment, never both. |
text | If present, the fixed text for this segement. Either text or paramName will be defined for a segment, never both. |
Property Details
isRequiredParam
Whether the parameter is required in order for the URL to be valid.
isRequiredParam?: boolean
Property Value
boolean
isWildCardParam
For parameters, whether or not this parameter is a wildcard (*) parameter, which means it allows multiple path segments (i.e. don't escape "/")
isWildCardParam?: boolean
Property Value
boolean
paramName
If present, the name of the route value parameter to substitute for this segment. Either text or paramName will be defined for a segment, never both.
paramName?: string
Property Value
string
text
If present, the fixed text for this segement. Either text or paramName will be defined for a segment, never both.
text?: string
Property Value
string
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for