Home > @momentum-design/common > Command > prepare

Command.prepare() method

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Prepare the processed results for emiting as a string.

Signature:

abstract prepare(results: any): Promise<string>;

Parameters

ParameterTypeDescription
resultsanyProcessed results.

Returns:

Promise<string>

Remarks

This method should be implemented in class definitions that extend this class. The scope of this method is to perform a transform on the provided results into a string. Since this can require async operation, the override method must return a Promise for API consistency.