UNPKG

@metamask/snaps-sdk

Version:

A library containing the core functionality for building MetaMask Snaps

1 lines 1.16 kB
{"version":3,"file":"schedule-background-event.mjs","sourceRoot":"","sources":["../../../src/types/methods/schedule-background-event.ts"],"names":[],"mappings":"","sourcesContent":["import type { Cronjob } from '../permissions';\n\n/**\n * An object containing the parameters for the `snap_scheduleBackgroundEvent`\n * method.\n */\nexport type ScheduleBackgroundEventParams =\n | {\n /**\n * The ISO 8601 date string of when to fire the background event (e.g.,\n * `\"2025-01-01T00:00:00Z\"`).\n */\n date: string;\n\n /**\n * The JSON-RPC request to call when the event fires.\n */\n request: Cronjob['request'];\n }\n | {\n /**\n * The ISO 8601 duration string of how long to wait before firing the\n * background event (e.g., `\"P1D\"` for one day). The resulting date will\n * be calculated in UTC.\n */\n duration: string;\n\n /**\n * The JSON-RPC request to call when the event fires.\n */\n request: Cronjob['request'];\n };\n\n/**\n * The ID of the scheduled background event.\n */\nexport type ScheduleBackgroundEventResult = string;\n"]}