Skip to content

routier-collection


routier-collection / core/src / formatExplanation

Function: formatExplanation() ​

formatExplanation(explanation): string

Defined in: core/src/plugins/query/formatExplanation.ts:231

Renders an explanation for a terminal.

The STEP headers carry the whole lesson: a reader who has never heard of pushdown still sees that the statement in step 1 is not the entire query. Nobody should have to notice a missing ORDER BY to work that out.

Parameters ​

explanation ​

QueryExplanation

Returns ​

string

Released under the MIT License.