Skip to content

Commit 464b23d

Browse files
committedOct 10, 2022
Add export of Result type
Closes GH-18.
1 parent 8ab2c5f commit 464b23d

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed
 

‎index.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/**
22
* @typedef {import('./lib/index.js').Child} Child
33
* @typedef {import('./lib/index.js').Properties} Properties
4+
* @typedef {import('./lib/index.js').Result} Result
45
*/
56

67
export {h, s} from './lib/index.js'

‎lib/index.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/**
22
* @typedef {import('./core.js').HChild} Child
33
* @typedef {import('./core.js').HProperties} Properties
4+
* @typedef {import('./core.js').HResult} Result
45
*/
56

67
export {h} from './html.js'

‎readme.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,11 @@ different files.
254254
## Types
255255

256256
This package is fully typed with [TypeScript][].
257-
It exports the additional types `Child` and `Properties`.
257+
It exports the additional types:
258+
259+
* `Child` — valid value used as a child
260+
* `Properties` — valid properties passed to an element
261+
* `Result` — output of a `h` (or `s`) call
258262

259263
## Compatibility
260264

0 commit comments

Comments
 (0)
Please sign in to comment.