소스 검색

Update documentation

Specify options to their respective input types.
master
부모
커밋
484fbb2b7e
1개의 변경된 파일10개의 추가작업 그리고 7개의 파일을 삭제
  1. +10
    -7
      src/index.ts

+ 10
- 7
src/index.ts 파일 보기

@@ -246,8 +246,8 @@ export type HTMLInputCheckboxElement = HTMLInputElement & { type: typeof INPUT_T
*/
type GetInputCheckboxFieldValueOptions = {
/**
* Should we consider the `checked` attribute of checkboxes with no `value` attributes instead of
* the default value "on" when checked?
* Should we consider the `checked` attribute of `<input type="checkbox">` elements with no
* `value` attributes instead of the default value `"on"` when checked?
*
* This forces the field to get the `false` value when unchecked.
*/
@@ -377,8 +377,8 @@ export type HTMLInputFileElement = HTMLInputElement & { type: typeof INPUT_TYPE_
*/
type GetInputFileFieldValueOptions = {
/**
* Should we retrieve the `files` attribute of file inputs instead of the currently selected file
* names?
* Should we retrieve the `files` attribute of `<input type="file">` elements instead of the names
* of the currently selected files?
*/
getFileObjects?: true,
}
@@ -434,7 +434,8 @@ export type HTMLInputNumericElement = HTMLInputNumberElement | HTMLInputRangeEle
*/
type GetInputNumberFieldValueOptions = {
/**
* Should we force values to be numeric?
* Should we force values in `<input type="number">` and `<input type="range">` elements
* to be numeric?
*
* **Note:** Form values are retrieved to be strings by default, hence this option.
*/
@@ -522,8 +523,10 @@ export type HTMLInputDateLikeElement
*/
type GetInputDateFieldValueOptions = {
/**
* Should we force values to be dates?
* @note Form values are retrieved to be strings by default, hence this option.
* Should we force date-like values in `<input type="date">`, `<input type="datetime-local">`,
* and `<input type="month">` elements to be date objects?
*
* **Note:** Form values are retrieved to be strings by default, hence this option.
*/
forceDateValues?: true,
};


불러오는 중...
취소
저장