[TypeScript] Can't match a request body if it contains a readonly array

[laurence-myers]

What is the expected behavior?

Can pass an object containing a readonly array as a request matching object.

What is the actual behavior?

TSC compares against each type in the union DataMatcher, fails to match on the type DataMatcherArray, reaches the last type in the union - DataMatcherMap - and raises a confusing error message, masking the root cause.

error TS2345: Argument of type 'Foo' is not assignable to parameter of type 'string | RegExp | Buffer | DataMatcherArray | DataMatcherMap | ((body: any) => boolean) | undefined'.
  Type 'Foo' is not assignable to type 'DataMatcherMap'.
    Index signature is missing in type 'Foo'.

Possible solution

Change the definition of DataMatcherArray, from this:

interface DataMatcherArray extends Array<DataMatcher> {}

To this:

interface DataMatcherArray extends ReadonlyArray<DataMatcher> {}

How to reproduce the issue

interface Foo {
  bar: readonly string[];
}

const requestToMatch: Foo = {
  bar: ['baz']
};

nock(someHost)
  .post(someUrl, requestToMatch) // <-- TSC error occurs here
  .reply(201);

Does the bug have a test case?

No, it affects the type definitions.

Versions

Software	Version(s)
Nock	13.0.7
Node	v14.15.4
TypeScript	4.1.3

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We try to do our best, but nock is maintained by volunteers and there is only so much we can do at a time. Thank you for your contributions.

[laurence-myers]

I've raised PR #2215 to address this.

[github-actions]

🎉 This issue has been resolved in version 13.1.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀