Skip to content

Commit

Permalink
Add export of Result type
Browse files Browse the repository at this point in the history
Closes GH-18.
  • Loading branch information
wooorm committed Oct 10, 2022
1 parent 8ab2c5f commit 464b23d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* @typedef {import('./lib/index.js').Child} Child
* @typedef {import('./lib/index.js').Properties} Properties
* @typedef {import('./lib/index.js').Result} Result
*/

export {h, s} from './lib/index.js'
1 change: 1 addition & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* @typedef {import('./core.js').HChild} Child
* @typedef {import('./core.js').HProperties} Properties
* @typedef {import('./core.js').HResult} Result
*/

export {h} from './html.js'
Expand Down
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,11 @@ different files.
## Types

This package is fully typed with [TypeScript][].
It exports the additional types `Child` and `Properties`.
It exports the additional types:

* `Child` — valid value used as a child
* `Properties` — valid properties passed to an element
* `Result` — output of a `h` (or `s`) call

## Compatibility

Expand Down

0 comments on commit 464b23d

Please sign in to comment.