@asgardeo/javascript
Version:
Framework agnostic JavaScript SDK for Asgardeo.
37 lines (36 loc) • 1.52 kB
TypeScript
/**
* Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
*
* WSO2 LLC. licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Processes OpenID scopes to ensure they are in the correct format.
* If the input is a string, it returns it as is.
* If the input is an array, it joins the elements into a single string separated by spaces.
* If the input is neither, it throws an error.
*
* @param scopes - The OpenID scopes to process, which can be a string or an array of strings.
* @returns A string of OpenID scopes separated by spaces.
*
* @example
* ```typescript
* processOpenIDScopes("openid profile email"); // returns "openid profile email"
* processOpenIDScopes(["openid", "profile", "email"]); // returns "openid profile email"
* processOpenIDScopes(123); // throws AsgardeoRuntimeError
* processOpenIDScopes({}); // throws AsgardeoRuntimeError
* ```
*/
declare const processOpenIDScopes: (scopes: string | string[]) => string;
export default processOpenIDScopes;