Skip to main content

index/functions/isValidApiKeyRole.md

isValidApiKeyRole(role): role is ApiKeyRole

Check if a string is a valid API key role.

Parameters​

ParameterTypeDescription
rolestringThe role string to validate

Returns​

role is ApiKeyRole

True if the role is valid

Example​

isValidApiKeyRole('MODERATOR') // true
isValidApiKeyRole('ADMIN') // false