Header menu logo Navs

UrlMatch Module

Functions and values

Function or value Description

UrlMatch.getFromParams name urlMatch

Full Usage: UrlMatch.getFromParams name urlMatch

Parameters:
    name : string - The name of the parameter to get
    urlMatch : UrlMatch - The match result to get the parameter from

Returns: 'CastedType voption The parameter value if it exists in the query parameters or path segments and it was succesfully parsed to it's supplied type or None if it doesn't

Gets a parameter from the query parameters or segments of the URL

name : string

The name of the parameter to get

urlMatch : UrlMatch

The match result to get the parameter from

Returns: 'CastedType voption

The parameter value if it exists in the query parameters or path segments and it was succesfully parsed to it's supplied type or None if it doesn't

UrlMatch.getParamFromPath name urlMatch

Full Usage: UrlMatch.getParamFromPath name urlMatch

Parameters:
    name : string - The name of the parameter to get
    urlMatch : UrlMatch - The match result to get the parameter from

Returns: 'CastedType voption The parameter value if it exists in the path segments and it was succesfully parsed to it's supplied type or None if it doesn't

Gets a parameter from the path segments of the URL

name : string

The name of the parameter to get

urlMatch : UrlMatch

The match result to get the parameter from

Returns: 'CastedType voption

The parameter value if it exists in the path segments and it was succesfully parsed to it's supplied type or None if it doesn't

UrlMatch.getParamFromQuery name urlMatch

Full Usage: UrlMatch.getParamFromQuery name urlMatch

Parameters:
    name : string - The name of the parameter to get
    urlMatch : UrlMatch - The match result to get the parameter from

Returns: 'CastedType voption The parameter value if it exists in the query parameters and it was succesfully parsed to it's supplied type or None if it doesn't

Gets a parameter from the query parameters of the URL

name : string

The name of the parameter to get

urlMatch : UrlMatch

The match result to get the parameter from

Returns: 'CastedType voption

The parameter value if it exists in the query parameters and it was succesfully parsed to it's supplied type or None if it doesn't

UrlMatch.getParamSeqFromQuery name urlMatch

Full Usage: UrlMatch.getParamSeqFromQuery name urlMatch

Parameters:
    name : string - The name of the parameter to get
    urlMatch : UrlMatch - The match result to get the parameter from

Returns: 'CastedType seq voption The parameter values if it exists in the query parameters and it was succesfully parsed to it's supplied type or None if it doesn't

Gets a sequence of parameters from the supplied query key in the URL

name : string

The name of the parameter to get

urlMatch : UrlMatch

The match result to get the parameter from

Returns: 'CastedType seq voption

The parameter values if it exists in the query parameters and it was succesfully parsed to it's supplied type or None if it doesn't

Type something to start searching.