Skip to content

editJson<T>

Reads, edits, and writes back a JSON file using a provided edit function.

Import:

import { editJson } from 'obsidian-dev-utils/script-utils/json';

Signature:

function editJson(params: EditJsonParams<T>): Promise<void>

Parameters:

ParameterTypeDescription
paramsEditJsonParams<T>The parameters for the function.

Returns: Promise<void> — A Promise that resolves when the file has been edited and written.


Links to this page: