AeontelAeontel Docs

Schedules hooks

Hand-written shim. Generated CRUD hooks via ./schedules.gen. useFireSchedule stays hand-written.

Hooks

useCreateSchedule mutation

Create a schedule.

TypeScript
useCreateSchedule(options?: MutationOpts<Schedule, CreateScheduleParams>)

Types: Schedule · CreateScheduleParams

useDeleteSchedule mutation

Soft-delete a schedule.

TypeScript
useDeleteSchedule(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useFireSchedule composite

TypeScript
useFireSchedule(options?: MutationOpts<Schedule, string>)

Types: Schedule

useListSchedules query

List schedules.

TypeScript
useListSchedules(params?: Omit<ListSchedulesParams, | > & { filter?: ScheduleFilter; orderBy?: ScheduleOrderBy[]; } & ScheduleShorthands, options?: QueryOpts<Page<Schedule>>)

Types: ListSchedulesParams · ScheduleFilter · ScheduleOrderBy · ScheduleShorthands · Page · Schedule

usePurgeSchedule composite

Permanently delete a soft-deleted schedule.

TypeScript
usePurgeSchedule(options?: MutationOpts<SuccessResponse, PurgeScheduleParams>)

Types: SuccessResponse · PurgeScheduleParams

useRestoreSchedule composite

Restore a soft-deleted schedule.

TypeScript
useRestoreSchedule(options?: MutationOpts<Schedule, string>)

Types: Schedule

useRetrieveSchedule query

Get a schedule by ID.

TypeScript
useRetrieveSchedule(id: string, options?: QueryOpts<Schedule>)

Types: Schedule

useUpdateSchedule mutation

Update a schedule.

TypeScript
useUpdateSchedule(options?: MutationOpts<Schedule, UpdateScheduleParams>)

Types: Schedule · UpdateScheduleParams