Home > @uniformdev/project-map

project-map package

Classes

<table><thead><tr><th>

Class

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

ProjectMapClient

</td><td>

</td></tr> <tr><td>

Route

</td><td>

</td></tr> <tr><td>

UncachedProjectMapClient

</td><td>

</td></tr> </tbody></table>

Functions

<table><thead><tr><th>

Function

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

getNodeLocalePath(node, locale)

</td><td>

Given a project map node and a locale, resolves the correct path for the locale This is computed as follows: - If the locale is unspecified, then use the fallback path - If the locale is specified, then use the locale-specific path if it exists, otherwise use the fallback path

</td></tr> <tr><td>

getNodeLocalePath(node, locale)

</td><td>

</td></tr> <tr><td>

getRouteAlternateLocalesUrls(routeResponse)

</td><td>

Gets all possible locale specific URLs for a composition route response

This is appropriate for generating links to other locale versions of the current composition, such as for alternate language tags, language switchers, etc.

The URLs will be: * Computed based on the attached project map node path * Not include a base URL from the project map, if one is set * If a dynamic locale path segment exists, it will be rewritten automatically to the target locale

</td></tr> </tbody></table>

Variables

<table><thead><tr><th>

Variable

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

ROOT_NODE_PATH

</td><td>

</td></tr> </tbody></table>

Type Aliases

<table><thead><tr><th>

Type Alias

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

AlternateLocaleUrls

</td><td>

</td></tr> <tr><td>

ExpandOptions

</td><td>

</td></tr> <tr><td>

LocalePathNode

</td><td>

</td></tr> <tr><td>

MatchedRoute

</td><td>

</td></tr> <tr><td>

NodeType

</td><td>

</td></tr> <tr><td>

ProjectMapClientOptions

</td><td>

</td></tr> <tr><td>

ProjectMapDefinition

</td><td>

</td></tr> <tr><td>

ProjectMapDefinitions

</td><td>

</td></tr> <tr><td>

ProjectMapDefinitionWithId

</td><td>

</td></tr> <tr><td>

ProjectMapDeleteRequest

</td><td>

</td></tr> <tr><td>

ProjectMapGetRequest

</td><td>

</td></tr> <tr><td>

ProjectMapGetResponse

</td><td>

</td></tr> <tr><td>

ProjectMapNode

</td><td>

</td></tr> <tr><td>

ProjectMapNodeAllowedQueryString

</td><td>

</td></tr> <tr><td>

ProjectMapNodeData

</td><td>

</td></tr> <tr><td>

ProjectMapNodeDeleteRequest

</td><td>

</td></tr> <tr><td>

ProjectMapNodeGetRequest

</td><td>

</td></tr> <tr><td>

ProjectMapNodeGetResponse

</td><td>

</td></tr> <tr><td>

ProjectMapNodeLocale

</td><td>

</td></tr> <tr><td>

ProjectMapNodeUpsertRequest

</td><td>

</td></tr> <tr><td>

ProjectMapNodeUpsertRequestNode

</td><td>

</td></tr> <tr><td>

ProjectMapNodeUpsertRequestNodeLocale

</td><td>

</td></tr> <tr><td>

ProjectMapNodeWithId

</td><td>

</td></tr> <tr><td>

ProjectMapNodeWithProjectMapReference

</td><td>

</td></tr> <tr><td>

ProjectMapSubtree

</td><td>

</td></tr> <tr><td>

ProjectMapUpsertRequest

</td><td>

</td></tr> <tr><td>

ProjectMapUpsertResponse

</td><td>

</td></tr> <tr><td>

UnmatchedRoute

</td><td>

</td></tr> </tbody></table>