Bladeren bron

Add README

Include short details on using the library.
master
TheoryOfNekomata 3 jaren geleden
bovenliggende
commit
c0d6405873
1 gewijzigde bestanden met toevoegingen van 22 en 0 verwijderingen
  1. +22
    -0
      README.md

+ 22
- 0
README.md Bestand weergeven

@@ -0,0 +1,22 @@
# get-form-values

Get the value of a form using `HTMLFormElement.elements`.

## Usage

```typescript
import getFormValues from '@theoryofnekomata/get-form-values';

const form = document.getElementById('form')

// optional, but just in case there are multiple submit buttons in the form,
// individual submitters can be considered
const submitter = form.querySelector('[type="submit"]')

const values = getFormValues(form, submitter)
```

## Tests

The library has been tested on JSDOM through Jest, and the real DOM using
Cypress.

Laden…
Annuleren
Opslaan