rush-lib.subspacesconfiguration.requirevalidsubspacename.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > SubspacesConfiguration > requireValidSubspaceName

SubspacesConfiguration.requireValidSubspaceName() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Checks whether the provided string could be used as a subspace name. If not, an exception is thrown.

Signature:

static requireValidSubspaceName(subspaceName: string, splitWorkspaceCompatibility?: boolean): void;

Parameters

Parameter	Type	Description
subspaceName	string
splitWorkspaceCompatibility	boolean	(Optional)

Returns:

void

Remarks

This is a syntax check only; it does not test whether the subspace is actually defined in the Rush configuration.