Skip to content

fix: make replace optional in type declaration and update JSDoc #137

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.

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

Merged
merged 2 commits into from
Feb 8, 2020

Conversation

remarkablemark
Copy link
Owner

What is the motivation for this pull request?

Fixes index.d.ts by making replace property optional in the 2nd argument object.

Also, updated and fixed incorrect JSDoc in lib/dom-to-react.js.

What is the current behavior?

If a 2nd argument is specified, replace is required so instead of:

{ replace: undefined }

Developers are forced to:

{ replace: () => {} }

See #134

What is the new behavior?

Developers are no longer forced to satisfy the type requirements. See above.

Checklist:

  • Documentation

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 801512b on fix/types into ccba051 on master.

@remarkablemark remarkablemark merged commit f8c0e3f into master Feb 8, 2020
@remarkablemark remarkablemark deleted the fix/types branch February 8, 2020 22:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants