hapijs / hapijs/bourne

Document the new export(s)

Open Beginner friendly
#35 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
JavaScript
Stars
180
Forks
13
PR merge metrics
No merged PRs in 30d

Description

### Module version

4.0.1

### What documentation problem did you notice?

When upgrading to `hapi/bourne` >= 4, the code breaks because you no longer have to do this:

```js
import Bourne from 'hapi/bourne'

// ...

parseJson: text => Bourne.safeParse(text)
```

Instead, you have to do this:

```js
import { safeParse } from '@hapi/bourne'

// ...
parseJson: text => safeParse(text)
```

The thing is, while it's really minor and I solved the problem in seconds, this change isn't documented anywhere.

Contributor guide

Open the contributing guide

Research direction

Start by locating the package's usage documentation and any v4 migration notes, then compare them with the old and new examples in the issue. Document the v4 package name and named safeParse import, and verify that the current guidance no longer shows the obsolete import pattern.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.