Skip to content

EditJsonParams<T>

Parameters for editJson.

Import:

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

Signature:

export interface EditJsonParams<T> extends EditJsonOptions

Extends: EditJsonOptions

Properties

PropertyTypeDescription
pathstringThe path to the JSON file.
shouldSkipIfMissing?booleanIf true, skips editing if the file does not exist.
(Inherited from EditJsonOptions)

Methods

MethodReturnsDescription
editFn(this, data)Promisable<void>The function to edit the parsed JSON data.

Links to this page: