Class Slugger

Responsible for getting a unique anchor for elements within a page.

Index

Constructors

Methods

getSimilarAnchors hasAnchor slug

Constructors

constructor

new Slugger(options: { lowercase: boolean }): Slugger
Parameters
- options: { lowercase: boolean }
Returns Slugger
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/typedoc/dist/lib/output/themes/default/Slugger.d.ts:9

Methods

getSimilarAnchors

getSimilarAnchors(anchor: string): string[]
Parameters
- anchor: string
Returns string[]
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/typedoc/dist/lib/output/themes/default/Slugger.d.ts:12

hasAnchor

hasAnchor(anchor: string): boolean
Parameters
- anchor: string
Returns boolean
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/typedoc/dist/lib/output/themes/default/Slugger.d.ts:11

slug

slug(value: string): string
Parameters
- value: string
Returns string
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/typedoc/dist/lib/output/themes/default/Slugger.d.ts:10