Skip to content
On this page

Function: capText()

TypeScript
function capText(
   reason: string, 
   retryAt: unknown, 
   alternative?: string): string | null;

Defined in: caps.ts:50 (opens in a new tab)

The sentence for a cap's reason code, or null when reason is not one. alternative is what else the reader can do, as a clause ("sign in another way"), or '' when nothing else would help; a cap on new accounts offers none, since every way makes the account from the same network.

ParametersLink to this section

ParameterTypeDefault
reasonstringDefault undefined
retryAtunknownDefault undefined
alternativestringDefault 'sign in another way'

ReturnsLink to this section

string | null