Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate all typedefs into their own JSDoc blocks #878

Merged
merged 1 commit into from
Jan 2, 2025
Merged

Separate all typedefs into their own JSDoc blocks #878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,14 @@
* Parent of `element`.
* @returns {boolean | null | undefined}
* Whether to allow `element` (default: `false`).
*
*/

/**
* @typedef {Partial<JsxRuntimeComponents>} Components
* Map tag names to components.
*
*/

/**
* @typedef Deprecation
* Deprecation.
* @property {string} from
Expand All @@ -30,7 +34,9 @@
* ID in readme.
* @property {keyof Options} [to]
* New field.
*
*/

/**
* @typedef Options
* Configuration.
* @property {AllowElement | null | undefined} [allowElement]
Expand Down Expand Up @@ -62,7 +68,9 @@
* with `unwrapDisallowed` the element itself is replaced by its children.
* @property {UrlTransform | null | undefined} [urlTransform]
* Change URLs (default: `defaultUrlTransform`)
*
*/

/**
* @callback UrlTransform
* Transform all URLs.
* @param {string} url
Expand Down
Loading