Module "wordpress-packages/utils/lib/factory/ajax/commonUrlBuilder"
Type aliases
RouteLocationInterface
RouteParamsInterface
RouteRequestInterface
RouteResponseInterface
Functions
applyQueryString
- applyQueryString(url: URL, query: any, merge?: boolean): URL
-
Parameters
-
url: URL
-
query: any
-
Optional merge: boolean
Returns URL
commonUrlBuilder
- commonUrlBuilder(__namedParameters: { cookieValueAsParam: string[]; location: RouteLocationInterface; nonce: boolean; options: { restNamespace: BaseOptions["restNamespace"]; restNonce?: BaseOptions["restNonce"]; restQuery?: BaseOptions["restQuery"]; restRecreateNonceEndpoint?: BaseOptions["restRecreateNonceEndpoint"]; restRoot: BaseOptions["restRoot"] }; params: IRouteParamsInterface }): string
-
Parameters
-
__namedParameters: { cookieValueAsParam: string[]; location: RouteLocationInterface; nonce: boolean; options: { restNamespace: BaseOptions["restNamespace"]; restNonce?: BaseOptions["restNonce"]; restQuery?: BaseOptions["restQuery"]; restRecreateNonceEndpoint?: BaseOptions["restRecreateNonceEndpoint"]; restRoot: BaseOptions["restRoot"] }; params: IRouteParamsInterface }
-
cookieValueAsParam: string[]
-
-
nonce: boolean
-
options: { restNamespace: BaseOptions["restNamespace"]; restNonce?: BaseOptions["restNonce"]; restQuery?: BaseOptions["restQuery"]; restRecreateNonceEndpoint?: BaseOptions["restRecreateNonceEndpoint"]; restRoot: BaseOptions["restRoot"] }
-
restNamespace: BaseOptions["restNamespace"]
-
Optional restNonce?: BaseOptions["restNonce"]
-
Optional restQuery?: BaseOptions["restQuery"]
-
Optional restRecreateNonceEndpoint?: BaseOptions["restRecreateNonceEndpoint"]
-
restRoot: BaseOptions["restRoot"]
-
Returns string
Build an URL for a specific scheme.