创建预设

提示

请务必先阅读如何正确使用酒馆助手

点击查看对应类型定义文件 (可发给 AI 或 IDE 使用, 酒馆助手界面中提供了打包下载)

createPreset

新建 preset_name 预设, 内容为 preset

createPreset

function createPreset(preset_name: Exclude<string, 'in_use'>, preset?: Preset): Promise<boolean>;

参数

preset_name

• 类型: string
• 描述: 预设名称

preset

• 类型: Preset
• 描述: 预设内容; 不填则使用默认内容

返回值

• 是否成功创建, 如果已经存在同名预设或尝试创建名为 'in_use' 的预设会失败: boolean

异常

• 如果创建的预设内容中存在重复的系统/占位提示词, 将会抛出异常

createOrReplacePreset

创建或替换名为 preset_name 的预设, 内容为 preset

function createOrReplacePreset(
  preset_name: LiteralUnion<'in_use', string>,
  preset?: Preset,
  { render }?: ReplacePresetOptions,
): Promise<boolean>;

参数

preset_name

• 类型: string
• 描述: 预设名称

preset

• 类型: Preset
• 描述: 预设内容; 不填则使用默认内容

option?

一个可选的配置对象, 包含以下属性:

• render: debounced|immediate
  • 如果对 'in_use' 预设进行操作, 应该防抖重新渲染 (debounced) 还是立即重新渲染 (immediate) 预设界面? 默认为性能更好的防抖渲染

返回值

• 是否成功创建或替换, 如果发生创建, 则返回 true; 如果发生替换, 则返回 false: boolean