lib/makeAPIRoute

Variables

apiRoute()

const apiRoute: (route: string) => string;

Defined in: studiocms/packages/studiocms/src/lib/makeAPIRoute.ts:39

Creates an API route for the ‘renderer’ service.

This function utilizes the makeAPIRoute utility to generate a route specifically for the ‘renderer’ service.

Parameters

route

string

Returns

string

Constant

---

sdkRouteResolver()

const sdkRouteResolver: (route: string) => string;

Defined in: studiocms/packages/studiocms/src/lib/makeAPIRoute.ts:29

Resolves the API route for the SDK.

This function uses the makeAPIRoute utility to generate the API route specifically for the SDK.

Parameters

route

string

Returns

string

Constant

---

v1RestRoute()

const v1RestRoute: (route: string) => string;

Defined in: studiocms/packages/studiocms/src/lib/makeAPIRoute.ts:54

Creates a REST API route for version 1.

Parameters

route

string

Returns

string

Constant

Functions

makeAPIRoute()

function makeAPIRoute(path: string): (route: string) => string

Defined in: studiocms/packages/studiocms/src/lib/makeAPIRoute.ts:15

Creates a function that generates API route strings.

Parameters

path

string

The base path for the API route.

Returns

Function

A function that takes a route string and returns the full API route.

Parameters

route

string

Returns

string

Example

const apiRoute = makeAPIRoute('users');
const fullRoute = apiRoute('profile'); // Returns '/studiocms_api/users/profile'

---

restRoute()

function restRoute(version: "v1"): (route: string) => string

Defined in: studiocms/packages/studiocms/src/lib/makeAPIRoute.ts:47

Generates a REST API route string for the specified version.

Parameters

version

"v1"

The version of the REST API.

Returns

Function

The complete API route string for the given version.

Parameters

route

string

Returns

string