Note kit command
property.set
Set a property
Sets a front-matter property to a string, number, boolean, null or list of strings in the key's own writing style, adding the property (and the front matter) when it is missing.
- Kit
- Note 0.3.0 (Markdown (.md))
- Changes the document
- yes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | yes | A top-level property key. |
value | any | yes | A string, number, boolean, null, or a list of strings. |
Call through note_run
text
note_run {
"path": "<file>.md",
"steps": [{ "command": "property.set", "params": { "key": <string>, "value": <any> } }]
}The required parameters, with placeholders for their types: not a tested example. note_run answers the step’s result in completed[i].result.
Result
| Name | Type | Required | Description |
|---|---|---|---|
changed | boolean | yes | Whether 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"
},
"value": {
"description": "A string, number, boolean, null, or a list of strings."
}
},
"required": [
"key",
"value"
],
"type": "object"
}Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.