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

SubspacesConfiguration.explainIfInvalidSubspaceName() 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. Returns undefined if the name is valid; otherwise returns an error message.

Signature:

static explainIfInvalidSubspaceName(subspaceName: string, splitWorkspaceCompatibility?: boolean): string | undefined;

Parameters

Parameter	Type	Description
subspaceName	string
splitWorkspaceCompatibility	boolean	(Optional)

Returns:

string | undefined

Remarks

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