TypeDoc API - v0.28.2
Docs
Example
GitHub
Preparing search index...
Slugger
Class Slugger
Responsible for getting a unique anchor for elements within a page.
Index
Constructors
constructor
Methods
get
Similar
Anchors
has
Anchor
slug
Constructors
constructor
new
Slugger
(
options
:
{
lowercase
:
boolean
}
)
:
Slugger
Parameters
options
:
{
lowercase
:
boolean
}
Returns
Slugger
Methods
get
Similar
Anchors
getSimilarAnchors
(
anchor
:
string
)
:
string
[]
Parameters
anchor
:
string
Returns
string
[]
has
Anchor
hasAnchor
(
anchor
:
string
)
:
boolean
Parameters
anchor
:
string
Returns
boolean
slug
slug
(
value
:
string
)
:
string
Parameters
value
:
string
Returns
string
Settings
Member Visibility
Protected
Inherited
Internal
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Similar
Anchors
has
Anchor
slug
Docs
Example
GitHub
TypeDoc API - v0.28.2
Loading...
Responsible for getting a unique anchor for elements within a page.