puter.apps.checkName()

Checks whether an app name is free, without creating anything. App names are unique across all Puter accounts, so a name is free only when no app on any account uses it. Useful before calling puter.apps.create(), which rejects when the name is already taken.

Syntax

puter.apps.checkName(name)

Parameters

name (String) (required)

The app name to check. Rejects with an invalid_request error when it is missing or empty.

Return value

A Promise that will resolve to an object describing the name's availability.

Examples

Check a name before creating the app

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        (async () => {
            const appName = puter.randName();

            // (1) A freshly generated name is available
            puter.print(JSON.stringify(await puter.apps.checkName(appName)) + '<br>');

            // (2) Create the app, which takes the name
            await puter.apps.create(appName, 'https://example.com');

            // (3) The same name now reports differently
            puter.print(JSON.stringify(await puter.apps.checkName(appName)) + '<br>');

            // (4) Delete the app (cleanup)
            await puter.apps.delete(appName);
        })();
    </script>
</body>
</html>