Skip to content

Function: getValidProjectKey() ​

ts
function getValidProjectKey(
   client, 
   parameters?, 
   options?
): Promise<string>;

Defined in: src/cloud/api/projectKeyAndNameValidation.ts:36

Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Permissions required: None.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ key?: string; }-
parameters.key?stringThe project key.
options?RequestOptions-

Returns ​

Promise<string>