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.

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

Fix build error from RawAxiosHeaders #971

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkalberer
Copy link

I'm getting the following error:

Exported variable 'runRules' has or is using name 'RawAxiosHeaders' from external module ".../axios/index" but cannot be named.

For code that looks like this:

export const runRules = <ThrowOnError extends boolean = true>(options: Options<RunRulesData, ThrowOnError>) => {
  return (options?.client ?? client).post<RunRulesResponse, RunRulesError, ThrowOnError>({
    ...options,
    url: '/fixer/run',
  });
};

The build error is happening for APIs where the body is a required parameter.


I think the main issue here is that RawAxiosHeaders is not exported from axios but you're using it as an exported type here.

Anyways, AxiosRequestHeaders + your Record type seems to cover most of what CreateAxiosDefaults['headers'] includes.

I'm getting the following error:
```
Exported variable 'runRules' has or is using name 'RawAxiosHeaders' from external module ".../axios/index" but cannot be named.
```

For code that looks like this:
```
export const runRules = <ThrowOnError extends boolean = true>(options: Options<RunRulesData, ThrowOnError>) => {
  return (options?.client ?? client).post<RunRulesResponse, RunRulesError, ThrowOnError>({
    ...options,
    url: '/fixer/run',
  });
};
```

The build error is happening for APIs where the `body` is a required parameter.

---

I think the main issue here is that `RawAxiosHeaders` is not exported from `axios` but you're using it as an exported type here. 

Anyways, `AxiosRequestHeaders` + your `Record` type seems to cover most of what `CreateAxiosDefaults['headers']` includes.
Copy link

stackblitz bot commented Aug 23, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Aug 23, 2024

⚠️ No Changeset found

Latest commit: 84af6e6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Aug 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hey-api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 23, 2024 6:31pm

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.

1 participant