Cancel async work
Stop invoked async logic when the machine leaves its state.
XState v6 is in beta
APIs and behavior may change before the stable release. Read the stable v5 docs.
Invoked actors follow the lifecycle of the state that invokes them. Leaving the state stops the actor.
const uploadFile = createAsyncLogic({
run: async ({ input, signal }: { input: { file: File } }) => {
const response = await fetch('/api/upload', {
method: 'POST',
body: input.file,
signal
});
return response.json();
}
});
const uploadMachine = createMachine({
context: ({ input }: { input: { file: File } }) => ({ file: input.file }),
initial: 'idle',
states: {
idle: { on: { upload: { target: 'uploading' } } },
uploading: {
invoke: {
src: uploadFile,
input: ({ context }) => ({ file: context.file }),
onDone: { target: 'complete' },
onError: { target: 'failed' }
},
on: { cancel: { target: 'idle' } }
},
complete: { type: 'final' },
failed: { on: { retry: { target: 'uploading' } } }
}
});Sending cancel leaves uploading. XState aborts the async actor's signal. Pass that signal to APIs such as fetch.
Use the same pattern to cancel stale search requests when the query changes or stop route data loading when a user navigates away.