Home > @uniformdev/project-map

project-map package

Classes

ClassDescription
ProjectMapClient
Route
UncachedProjectMapClient

Functions

FunctionDescription
getNodeLocalePath(node, locale)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
getNodeLocalePath(node, locale)
getRouteAlternateLocalesUrls(routeResponse)<p>Gets all possible locale specific URLs for a composition route response</p><p>This is appropriate for generating links to other locale versions of the current composition, such as for alternate language tags, language switchers, etc.</p><p>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</p>

Variables

VariableDescription
ROOT_NODE_PATH

Type Aliases

Type AliasDescription
AlternateLocaleUrls
ExpandOptions
LocalePathNode
MatchedRoute
NodeType
ProjectMapClientOptions
ProjectMapDefinition
ProjectMapDefinitions
ProjectMapDefinitionWithId
ProjectMapDeleteRequest
ProjectMapGetRequest
ProjectMapGetResponse
ProjectMapNode
ProjectMapNodeAllowedQueryString
ProjectMapNodeData
ProjectMapNodeDeleteRequest
ProjectMapNodeGetRequest
ProjectMapNodeGetResponse
ProjectMapNodeLocale
ProjectMapNodeUpsertRequest
ProjectMapNodeUpsertRequestNode
ProjectMapNodeUpsertRequestNodeLocale
ProjectMapNodeWithId
ProjectMapNodeWithProjectMapReference
ProjectMapSubtree
ProjectMapUpsertRequest
ProjectMapUpsertResponse
UnmatchedRoute