submit — Angular | Spec-Zone.ru

Отправляет заданное FieldTree с помощью указанной функции действия и применяет к полю все ошибки отправки, возникшие в результате выполнения действия. Ошибки отправки, возвращённые action, будут добавлены в поле как ValidationError для под-поля, указанного свойством fieldTree ошибки отправки.

API

function submit<TModel>(
  form: FieldTree<TModel>,
  options?: NoInfer<FormSubmitOptions<unknown, TModel>> | undefined,
): Promise<boolean>;
function submit<TModel>(
  form: FieldTree<TModel>,
  action: NoInfer<
    (
      field: FieldTree<TModel, string | number, 'writable'>,
      detail: {
        root: FieldTree<unknown, string | number, 'writable'>;
        submitted: FieldTree<TModel, string | number, 'writable'>;
      },
    ) => Promise<TreeValidationResult<WithOptionalFieldTree>>
  >,
): Promise<boolean>;

function submit<TModel>(form: FieldTree<TModel>, options?: NoInfer<FormSubmitOptions<unknown, TModel>> | undefined): Promise<boolean>;

Параллельная отправка запрещена. Если для указанного поля или любого из его родительских полей уже выполняется отправка, последующие вызовы submit немедленно вернут false, не выполняя действие.

@paramformFieldTree<TModel>

Поле для отправки.

@paramoptionsNoInfer<FormSubmitOptions<unknown, TModel>> | undefined

Параметры отправки.

@returnsPromise<boolean>

Указывает, была ли отправка успешной.

Примечания по использованию

async function registerNewUser(registrationForm: FieldTree<{username: string, password: string}>) {
  const result = await myClient.registerNewUser(registrationForm().value());
  if (result.errorCode === myClient.ErrorCode.USERNAME_TAKEN) {
    return [{
      fieldTree: registrationForm.username,
      kind: 'server',
      message: 'Username already taken'
    }];
  }
  return undefined;
}

const registrationForm = form(signal({username: 'god', password: ''}));
submit(registrationForm, {
  action: async (f) => {
    return registerNewUser(registrationForm);
  }
});
registrationForm.username().errors(); // [{kind: 'server', message: 'Username already taken'}]

function submit<TModel>(form: FieldTree<TModel>, action: NoInfer<(field: FieldTree<TModel, string | number, "writable">, detail: { root: FieldTree<unknown, string | number, "writable">; submitted: FieldTree<TModel, string | number, "writable">; }) => Promise<TreeValidationResult<WithOptionalFieldTree>>>): Promise<boolean>;

@paramformFieldTree<TModel>

@paramaction

NoInfer<(field: FieldTree<TModel, string | number, "writable">, detail: { root: FieldTree<unknown, string | number, "writable">; submitted: FieldTree<TModel, string | number, "writable">; }) => Promise<TreeValidationResult<WithOptionalFieldTree>>>

@returnsPromise<boolean>

Описание

Примечания по использованию

async function registerNewUser(registrationForm: FieldTree<{username: string, password: string}>) {
  const result = await myClient.registerNewUser(registrationForm().value());
  if (result.errorCode === myClient.ErrorCode.USERNAME_TAKEN) {
    return [{
      fieldTree: registrationForm.username,
      kind: 'server',
      message: 'Username already taken'
    }];
  }
  return undefined;
}

const registrationForm = form(signal({username: 'god', password: ''}));
submit(registrationForm, {
  action: async (f) => {
    return registerNewUser(registrationForm);
  }
});
registrationForm.username().errors(); // [{kind: 'server', message: 'Username already taken'}]