@luigi-project/client 2.6.3 → 2.6.4-dev.20231080027
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/luigi-element.d.ts +22 -0
- package/package.json +1 -1
package/luigi-element.d.ts
CHANGED
|
@@ -443,4 +443,26 @@ export interface LuigiClient {
|
|
|
443
443
|
* @memberof LuigiClient
|
|
444
444
|
*/
|
|
445
445
|
setAnchor: (anchor: string) => void;
|
|
446
|
+
/**
|
|
447
|
+
* Retrieves the search params from the active URL
|
|
448
|
+
* @returns {Object} containing the search params
|
|
449
|
+
* @memberof LuigiClient
|
|
450
|
+
*/
|
|
451
|
+
getCoreSearchParams: () => Object;
|
|
452
|
+
/**
|
|
453
|
+
* Returns the dynamic path parameters of the active URL.
|
|
454
|
+
* Path parameters are defined by navigation nodes with a dynamic **pathSegment** value starting with **:**, such as **productId**.
|
|
455
|
+
* All path parameters in the current navigation path (as defined by the active URL) are returned.
|
|
456
|
+
* <!-- add-attribute:class:warning -->
|
|
457
|
+
* > **NOTE:** some special characters (`<`, `>`, `"`, `'`, `/`) in path parameters are HTML-encoded.
|
|
458
|
+
* @returns {Object} path parameters, where the object property name is the path parameter name without the prefix, and its value is the actual value of the path parameter. For example ` {productId: 1234, ...}`
|
|
459
|
+
* @memberof LuigiClient
|
|
460
|
+
*/
|
|
461
|
+
getPathParams: () => Object;
|
|
462
|
+
/**
|
|
463
|
+
* Returns the current client permissions as specified in the navigation node or an empty object. For details, see [Node parameters](navigation-parameters-reference.md).
|
|
464
|
+
* @returns {Object} client permissions as specified in the navigation node
|
|
465
|
+
* @memberof LuigiClient
|
|
466
|
+
*/
|
|
467
|
+
getClientPermissions(): () => Object;
|
|
446
468
|
}
|
package/package.json
CHANGED