Skip to content

wrapCliTask

Wraps a CLI task function to ensure it runs safely and handles its CliTaskResult.

Import:

import { wrapCliTask } from 'obsidian-dev-utils/script-utils/cli-utils';

Signature:

function wrapCliTask(taskFn: () => Promisable<MaybeReturn<CliTaskResult>>): Promise<void>

Parameters:

ParameterTypeDescription
taskFn() => Promisable<MaybeReturn<CliTaskResult>>The task function to execute, which may return a CliTaskResult or void.

Returns: Promise<void> — A Promise that resolves when the task is completed and exits with the appropriate status.