Search
Preparing search index...
The search index is not available
StoreFront
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
@storefront/core
SearchUrlParser
Class SearchUrlParser
Hierarchy
UrlParser
<
SearchUrlState
>
SearchUrlParser
PastPurchaseUrlParser
Implements
Parser
<
SearchUrlState
>
Index
Constructors
constructor
Properties
beautifier
config
suffix
Pattern
Methods
generate
Refinement
Mapping
parse
parse
Path
With
Reference
Keys
extract
Range
Refinements
extract
Sort
extract
Unmapped
extract
Value
Refinements
parse
Path
Without
Reference
Keys
to
Keys
to
Object
Constructors
constructor
new
Search
Url
Parser
(
beautifier
:
UrlBeautifier
)
:
SearchUrlParser
Parameters
beautifier:
UrlBeautifier
Returns
SearchUrlParser
Properties
Protected
beautifier
beautifier
:
UrlBeautifier
config
config
:
Configuration
= this.beautifier.config
suffix
Pattern
suffix
Pattern
:
RegExp
= RegExp(`${this.config.suffix}$`)
Methods
generate
Refinement
Mapping
generate
Refinement
Mapping
(
)
:
any
Returns
any
parse
parse
(
url
:
string
)
:
SearchUrlState
Parameters
url:
string
Returns
SearchUrlState
parse
Path
With
Reference
Keys
parse
Path
With
Reference
Keys
(
path
:
string
[]
)
:
Partial
<
SearchUrlState
>
Parameters
path:
string
[]
Returns
Partial
<
SearchUrlState
>
Static
extract
Range
Refinements
extract
Range
Refinements
(
field
:
string
, low
:
number
, high
:
number
)
:
object
Parameters
field:
string
low:
number
high:
number
Returns
object
field
:
string
high
:
number
low
:
number
Static
extract
Sort
extract
Sort
(
sortString
:
string
)
:
object
Parameters
sortString:
string
Returns
object
descending
:
any
field
:
any
Static
extract
Unmapped
extract
Unmapped
(
refinementString
:
string
)
:
Refinement
[]
Parameters
refinementString:
string
Returns
Refinement
[]
Static
extract
Value
Refinements
extract
Value
Refinements
(
field
:
string
, value
:
string
)
:
object
Parameters
field:
string
value:
string
Returns
object
field
:
string
value
:
string
Static
parse
Path
Without
Reference
Keys
parse
Path
Without
Reference
Keys
(
path
:
string
[]
)
:
Partial
<
SearchUrlState
>
Parameters
path:
string
[]
Returns
Partial
<
SearchUrlState
>
Static
to
Keys
to
Keys
(
mapping
:
any
[]
)
:
any
Parameters
mapping:
any
[]
Returns
any
Static
to
Object
to
Object
(
mapping
:
any
[]
)
:
any
Parameters
mapping:
any
[]
Returns
any
Globals
@storefront/core
Beautifier
Factory
Configuration
Globals
Phase
Product
Transformer
Props
Provide
Consume
Pure
Selectors
Service
Structure
Tag
Utils
Url
Utils
Utils
@storefront/breadcrumbs
@storefront/collections
@storefront/core
Search
Url
Parser
constructor
beautifier
config
suffix
Pattern
generate
Refinement
Mapping
parse
parse
Path
With
Reference
Keys
extract
Range
Refinements
extract
Sort
extract
Unmapped
extract
Value
Refinements
parse
Path
Without
Reference
Keys
to
Keys
to
Object
@storefront/details
@storefront/did-
you-
mean
@storefront/flux-
capacitor
@storefront/infinite-
scroll
@storefront/navigation
@storefront/page-
size
@storefront/paging
@storefront/products
@storefront/query
@storefront/recommendations
@storefront/record-
count
@storefront/related-
queries
@storefront/sayt
@storefront/sort
@storefront/structure
@storefront/template
Generated using
TypeDoc