Note kit command
property.rename
Rename a property
Renames the front-matter property `key` to `to`, changing only the key and keeping its value and place.
- Kit
- Note 0.3.0 (Markdown (.md))
- Changes the document
- yes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key | string | yes | The property's key now. |
to | string | yes | The new key. |
Call through note_run
text
note_run {
"path": "<file>.md",
"steps": [{ "command": "property.rename", "params": { "key": <string>, "to": <string> } }]
}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": "The property's key now.",
"type": "string"
},
"to": {
"description": "The new key.",
"type": "string"
}
},
"required": [
"key",
"to"
],
"type": "object"
}Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.