Note kit command

property.delete

Delete a property

Deletes the front-matter property `key` and its lines; `occurrence` picks one when the key is written more than once.

Kit
Note 0.3.0 (Markdown (.md))
Changes the document
yes

Parameters

Parameters of property.delete
NameTypeRequiredDescription
keystringyesA top-level property key.
occurrenceintegernoWhich of a key written twice, from 1.

Call through note_run

text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "property.delete", "params": { "key": <string> } }]
}

The required parameters, with placeholders for their types: not a tested example. Optional: occurrence. note_run answers the step’s result in completed[i].result.

Result

Result of property.delete
NameTypeRequiredDescription
changedbooleanyesWhether the note's text changed (false when it already read so).
Result JSON Schema
json
{
  "additionalProperties": false,
  "properties": {
    "changed": {
      "description": "Whether the note's text changed (false when it already read so).",
      "type": "boolean"
    }
  },
  "required": [
    "changed"
  ],
  "type": "object"
}

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "key": {
      "description": "A top-level property key.",
      "type": "string"
    },
    "occurrence": {
      "description": "Which of a key written twice, from 1.",
      "type": "integer"
    }
  },
  "required": [
    "key"
  ],
  "type": "object"
}

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.