Function: getValidProjectName()

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

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

Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Permissions required: None.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ name: string; }	-
parameters.name	string	The project name.
options?	RequestOptions	-

Returns

Promise<string>