Documentation

ClientAware

This interface is used for [default error formatting](error-handling.md).

Only errors implementing this interface (and returning true from isClientSafe()) will be formatted with original error message.

All other errors will be formatted with generic "Internal server error".

Table of Contents

getCategory()  : string
Returns string describing a category of the error.
isClientSafe()  : bool
Returns true when exception message is safe to be displayed to a client.

Methods

getCategory()

Returns string describing a category of the error.

public getCategory() : string

Value "graphql" is reserved for errors produced by query parsing or validation, do not use it.

Return values
string

isClientSafe()

Returns true when exception message is safe to be displayed to a client.

public isClientSafe() : bool
Return values
bool

Search results