UNPKG

@joshfarrant/shortcuts-js

Version:
28 lines (27 loc) 798 B
import WFFrequency from '../interfaces/WF/WFFrequency'; import WFSerialization from '../interfaces/WF/WFSerialization'; import WFWorkflowAction from '../interfaces/WF/WFWorkflowAction'; /** * @action Create Alarm * @section Content Types > Calendar > Clock * @icon Clock * * Creates an alarm in the Clock app. * * ```js * createAlarm({ * label: 'Alarm', * time: '8 AM', * repeat: ['Sunday', 'Saturday'], * }); * ``` */ declare const createAlarm: ({ label, time, repeat, }: { /** The alarm label */ label?: string | WFSerialization | undefined; /** The alarm time */ time?: string | WFSerialization | undefined; /** Whether the alarm should repeat on certain days */ repeat?: WFFrequency[] | undefined; }) => WFWorkflowAction; export default createAlarm;