chore(typings): add typings #8
Conversation
types.d.ts
Outdated
| @@ -0,0 +1,37 @@ | |||
| export interface IDomDiffNodeMarkerOptions { | |||
There was a problem hiding this comment.
Please add the following description and feel free to ask more if needed.
A specific live node to use as boundary for all nodes operations.
With live nodes [a,d] and {before: d}, the operation [] => [b, c] would place nodes right before d, resulting a live collection of [a, b, c, d].
There was a problem hiding this comment.
P.S. even before doesn't have to be necessarily a Node
types.d.ts
Outdated
|
|
||
| export interface IDomDiffOptionsGenericComparisonFn { | ||
| /** | ||
| * A callback to compare between two generic nodes. returns `true` to indicate they are the same |
There was a problem hiding this comment.
This is inaccurate. You can compare anything, even objects, not just DOM nodes. Basically, this module handle any sort of object, including, as example, hyper.Component instances that are not nodes per se.
types.d.ts
Outdated
|
|
||
| export interface IDomDiffOPtionsEachNodeCallbackFn { | ||
| /** | ||
| * The optional `{node: (generic, info) => node}` is invoked per each operation on the DOM. |
There was a problem hiding this comment.
As inaccurate as the previous one. The generic Node is not a DOM node, it can be pretty much any object.
types.d.ts
Outdated
| export default function domdiff( | ||
| parentNode: Node, | ||
| currentNodes: ArrayLike<Node>, | ||
| futureNodes: ArrayLike<Node>, |
There was a problem hiding this comment.
Both currentNodes and futureNodes can be ArrayLike but if these are live collections things will go bananas. As example, body.getElementsByTagName('div') as collection wouldn't work, and so it wouldn't any collection that mutates live while DOM changes. I would probably stick with Array to avoid confusion and be clear about the kind of variable it is expecting.
On top of that, the <Node> type is also misleading, because this module handles every kind of object, even arrays, as shown in the example in the README.
Node in this whole types description, is not necessarily a Node. It could be a Node, but it could be literally any other kind of object (excluding null)
|
Fixed all as suggested 👍 . Note that most of the inaccurate description resulted from |
No description provided.