js: improve auto-save-controller documentation
This commit is contained in:
parent
ad8dcc7f7d
commit
4f33a7b72e
2 changed files with 7 additions and 2 deletions
|
@ -1,7 +1,12 @@
|
|||
import { ajax, fire, timeoutable } from '@utils';
|
||||
|
||||
// Manages a queue of Autosave operations,
|
||||
// and sends `autosave:*` events to indicate the state of the requests.
|
||||
// and sends `autosave:*` events to indicate the state of the requests:
|
||||
//
|
||||
// - autosave:enqueue () when an autosave request has been enqueued
|
||||
// - autosave:end ({ response, statusText, xhr }) when an autosave request finished successfully
|
||||
// - autosave:failure (Error) when an autosave request failed
|
||||
//
|
||||
export default class AutoSaveController {
|
||||
constructor() {
|
||||
this.timeoutDelay = 60000; // 1mn
|
||||
|
|
|
@ -29,7 +29,7 @@ const FORM_SELECTOR = 'form#dossier-edit-form.autosave-enabled';
|
|||
const INPUTS_SELECTOR = `${FORM_SELECTOR} input:not([type=file]), ${FORM_SELECTOR} select, ${FORM_SELECTOR} textarea`;
|
||||
const RETRY_BUTTON_SELECTOR = '.autosave-retry';
|
||||
|
||||
// When an autosave is requested programatically, auto-save the form immediately
|
||||
// When an autosave is requested programmatically, auto-save the form immediately
|
||||
addEventListener('autosave:trigger', (event) => {
|
||||
const form = event.target.closest('form');
|
||||
if (form && form.classList.contains('autosave-enabled')) {
|
||||
|
|
Loading…
Reference in a new issue