fix(form-core): add some type fixes/adjustments

This commit is contained in:
Joren Broekema 2020-09-30 17:41:23 +02:00 committed by Thomas Allmer
parent 7e2b7834e5
commit 4b7bea9656
3 changed files with 19 additions and 15 deletions

View file

@ -0,0 +1,5 @@
---
'@lion/form-core': patch
---
Added some type fixes/adjustments.

View file

@ -1,3 +1,13 @@
/**
* @typedef {object} MessageData
* @property {*} [MessageData.modelValue]
* @property {string} [MessageData.fieldName]
* @property {HTMLElement} [MessageData.formControl]
* @property {string} [MessageData.type]
* @property {Object.<string,?>} [MessageData.config]
* @property {string} [MessageData.name]
*/
export class Validator { export class Validator {
/** /**
* *
@ -65,12 +75,7 @@ export class Validator {
/** /**
* @overridable * @overridable
* @param {object} [data] * @param {MessageData} [data]
* @param {*} [data.modelValue]
* @param {string} [data.fieldName]
* @param {HTMLElement} [data.formControl]
* @param {*} [data.params]
* @param {string|undefined} [data.type]
* @returns {Promise<string|Node>} * @returns {Promise<string|Node>}
*/ */
async _getMessage(data) { async _getMessage(data) {
@ -96,13 +101,7 @@ export class Validator {
/** /**
* @overridable * @overridable
* @param {object} [data] * @param {MessageData} [data]
* @param {*} [data.modelValue]
* @param {string} [data.fieldName]
* @param {*} [data.params]
* @param {string} [data.type]
* @param {Object.<string,?>} [data.config]
* @param {string} [data.name]
* @returns {Promise<string|Node>} * @returns {Promise<string|Node>}
*/ */
// eslint-disable-next-line no-unused-vars // eslint-disable-next-line no-unused-vars

View file

@ -244,7 +244,7 @@ export function runValidateMixinFeedbackPart() {
let name = ''; let name = '';
if (this.feedbackData && this.feedbackData.length > 0) { if (this.feedbackData && this.feedbackData.length > 0) {
const ctor = /** @type {typeof Validator} */ (this.feedbackData[0]?.validator const ctor = /** @type {typeof Validator} */ (this.feedbackData[0]?.validator
.constructor); ?.constructor);
name = ctor.validatorName; name = ctor.validatorName;
} }
return html`Custom for ${name}`; return html`Custom for ${name}`;
@ -467,7 +467,7 @@ export function runValidateMixinFeedbackPart() {
// ignore fieldName Promise as it will always be unique // ignore fieldName Promise as it will always be unique
const compare = spy.args[0][0]; const compare = spy.args[0][0];
delete compare?.config.fieldName; delete compare?.config?.fieldName;
expect(compare).to.eql({ expect(compare).to.eql({
config: {}, config: {},
params: 4, params: 4,