Skip to content

Commit e812c79

Browse files
committedJan 3, 2023
Add improved docs
1 parent 501f668 commit e812c79

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+542
-402
lines changed
 

‎index.js

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
* @typedef {import('./lib/types.js').Info} SafeOptions
33
* To do: remove next major: renamed because it doesn’t really reflect
44
* options, but instead info on the surrounding of the generated thing.
5+
* @typedef {import('./lib/types.js').State} Context
6+
* To do: remove next major: renamed because the word state more clearly
7+
* represents one thing that is passed down to everything and is changed.
58
*/
69

710
/**
8-
* @typedef {import('./lib/types.js').Info} Info
9-
* @typedef {import('./lib/types.js').Context} Context
1011
* @typedef {import('./lib/types.js').Handle} Handle
1112
* @typedef {import('./lib/types.js').Handlers} Handlers
13+
* @typedef {import('./lib/types.js').Info} Info
1214
* @typedef {import('./lib/types.js').Join} Join
13-
* @typedef {import('./lib/types.js').Unsafe} Unsafe
1415
* @typedef {import('./lib/types.js').Options} Options
16+
* @typedef {import('./lib/types.js').State} State
17+
* @typedef {import('./lib/types.js').Unsafe} Unsafe
1518
* @typedef {import('./lib/util/indent-lines.js').Map} Map
1619
*/
1720

‎lib/configure.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/**
22
* @typedef {import('./types.js').Options} Options
3-
* @typedef {import('./types.js').Context} Context
3+
* @typedef {import('./types.js').State} State
44
*/
55

66
/**
7-
* @param {Context} base
7+
* @param {State} base
88
* @param {Options} extension
9-
* @returns {Context}
9+
* @returns {State}
1010
*/
1111
export function configure(base, extension) {
1212
let index = -1

0 commit comments

Comments
 (0)
Please sign in to comment.