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

Jump to bottom

DataMatcher type does not allow arrays be used for POST bodies #1724

Closed
mastermatt opened this issue Sep 19, 2019 · 1 comment · Fixed by #1725
Closed

DataMatcher type does not allow arrays be used for POST bodies #1724

mastermatt opened this issue Sep 19, 2019 · 1 comment · Fixed by #1725
Labels
released TypeScript Anything related to TypeScript

Comments

@mastermatt
Copy link
Member

I'm moving the conversation from another issue to it's own ticket at it turned out to not be related to the original issue.

First comment #1708 (comment) by @ctotheameron

This issue is an extension of #1702 which was partially fixed in #1703.

The DataMatcher type is used to type the optional body argument of "method" methods on Scopes (.post, .put, etc.) as well as typing the argument passed to Interceptor.query.

Of note is that arrays are valid types to pass .post, but it is not valid for .query.
@mastermatt mastermatt added the TypeScript Anything related to TypeScript label Sep 19, 2019
@mastermatt mastermatt mentioned this issue Sep 19, 2019
Closed
mastermatt added a commit to mastermatt/nock that referenced this issue Sep 19, 2019
@mastermatt
fix(types): data matcher for body and query.
9c23178 
Fixes: nock#1724
Closes: nock#1723

Updates the JSONish type using inspiration from the thread on adding a
JSON type to TS. microsoft/TypeScript#1897 (comment)

This change does a couple sublet things:
- Adds `undefined` to scalar values allowed in arrays or as values in objects.
  This allows for interfaces with optional keys to be passed in. ref nock#1723
- Splits out top-level array and objects into their interfaces so they could be used directly.
  Allows enforcing non-arrays for `.query`.
- `RequestBodyMatcher` now extends the array and map types instead of the raw `DataMatcher`.
  Allowing arrays fixes nock#1724.
  This also ensures that booleans, numbers, and `null` are not considered valid.
@mastermatt mastermatt mentioned this issue Sep 19, 2019
Merged
mastermatt added a commit that referenced this issue Sep 20, 2019
@mastermatt
fix(types): data matcher for body and query. (#1725)
59b345c 
* fix(types): data matcher for body and query.

Fixes: #1724
Closes: #1723

Updates the JSONish type using inspiration from the thread on adding a
JSON type to TS. microsoft/TypeScript#1897 (comment)

This change does a couple sublet things:
- Adds `undefined` to scalar values allowed in arrays or as values in objects.
  This allows for interfaces with optional keys to be passed in. ref #1723
- Splits out top-level array and objects into their interfaces so they could be used directly.
  Allows enforcing non-arrays for `.query`.
- `RequestBodyMatcher` now extends the array and map types instead of the raw `DataMatcher`.
  Allowing arrays fixes #1724.
  This also ensures that booleans, numbers, and `null` are not considered valid.
@nockbot
Copy link
Collaborator

nockbot commented Sep 20, 2019

🎉 This issue has been resolved in version 11.3.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@weekly-digest weekly-digest bot mentioned this issue Sep 22, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
released TypeScript Anything related to TypeScript
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(types): data matcher for body and query. mastermatt/nock
2 participants
@mastermatt @nockbot