Clarify error message for missing api key #115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you accidentally make a request with a missing api key, error message is ambiguous.
```javascript
// where process.env.AIRTABLE_KEY = null
Airtable.configure({
endpointUrl: 'https://api.airtable.com',
apiKey: process.env.AIRTABLE_KEY
})
...
```
Results in the error:
```
Error: API is required to connect to Airtable
```
In my case, I had forgotten to set the env var, so this throw me on a loop to figure out what `API is required` meant.
It would be more helpful if it instead described:
```
API Key is required to connect to Airtable
```
})
EvanHahn
suggested changes
Jun 13, 2019
`An API key is required to connect to Airtable`
EvanHahn
approved these changes
Jun 14, 2019
PeterPan627
added a commit
to PeterPan627/airtable.js
that referenced
this pull request
May 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you accidentally make a request with a missing api key, error message is ambiguous.
Results in the error:
I had forgotten to set the env var, so I was scratching my head to figure out what
API is requiredmeant. I think It would be more helpful if it instead described: