Skip to content

docs: handle a missing Authorization header in README examples #108

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

Merged
blakeembrey merged 2 commits into from
Oct 7, 2026
Merged

docs: handle a missing Authorization header in README examples #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dec578b
docs: handle a missing Authorization header in README examples
ucsurf Oct 6, 2026
7fc82f7
docs: apply review suggestion for Proxy-Authorization example
ucsurf Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ Pass a Basic auth header to the `parse()` method. If parsing fails

```js
const { parse } = require('basic-auth');
const user = parse(req.headers.authorization);
const user = parse(req.headers.authorization ?? '');
// => { name: 'something', pass: 'whatever' }
```

A header string from any other location can also be parsed for example a `Proxy-Authorization` header:

```js
const { parse } = require('basic-auth');
const user = parse(req.getHeader('Proxy-Authorization'));
const user = parse(req.getHeader('Proxy-Authorization') ?? '');
```

A credentials object can be formatted with `auth.format` as
Expand All @@ -71,7 +71,7 @@ const compare = require('tsscmp');

// Create server
const server = http.createServer(function (req, res) {
const credentials = parse(req.headers.authorization);
const credentials = parse(req.headers.authorization ?? '');

// Check credentials
// The "check" function will typically be against your user store
Expand Down
Loading