virtuals/lib/pathGenerators

Functions

ensureHtmlExtension()

function ensureHtmlExtension(path: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:65^

Add ‘.html’ extension to a path.

Parameters

path

string

Returns

string

---

ensureLeadingAndTrailingSlashes()

function ensureLeadingAndTrailingSlashes(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:29^

Ensure the passed path starts and ends with slashes.

Parameters

href

string

Returns

string

---

ensureLeadingSlash()

function ensureLeadingSlash(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:15^

Ensure the passed path starts with a leading slash.

Parameters

href

string

Returns

string

---

ensureTrailingSlash()

function ensureTrailingSlash(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:22^

Ensure the passed path ends with a trailing slash.

Parameters

href

string

Returns

string

---

fileWithBase()

function fileWithBase(path: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:9^

Get the a root-relative file URL path with the site’s base prefixed.

Parameters

path

string

Returns

string

---

pathWithBase()

function pathWithBase(path: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:2^

Get the a root-relative URL path with the site’s base prefixed.

Parameters

path

string

Returns

string

---

stripHtmlExtension()

function stripHtmlExtension(path: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:59^

Remove the extension from a path.

Parameters

path

string

Returns

string

---

stripLeadingAndTrailingSlashes()

function stripLeadingAndTrailingSlashes(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:51^

Ensure the passed path does not start and end with slashes.

Parameters

href

string

Returns

string

---

stripLeadingSlash()

function stripLeadingSlash(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:37^

Ensure the passed path does not start with a leading slash.

Parameters

href

string

Returns

string

---

stripTrailingSlash()

function stripTrailingSlash(href: string): string

Defined in: studiocms/packages/studiocms/src/virtuals/lib/pathGenerators.ts:44^

Ensure the passed path does not end with a trailing slash.

Parameters

href

string

Returns

string