Skip to content

Commit

Permalink
chore: add jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Feb 20, 2024
1 parent 38d0d48 commit 42c7ff6
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,31 @@ const {
} = require("confbox");
```

<!-- automd:jsdocs src="./src/index" -->

### `parseJSON5(text, options?)`

Converts a [JSON5](https://json5.org/) string into an object.

### `parseJSONC(text, options?)`

Converts a [JSONC](https://github.com/microsoft/node-jsonc-parser) string into an object.

### `parseToml(text)`

Converts a [TOML](https://toml.io/) string into an object.

### `parseYaml(text, options?)`

Converts a [YAML](https://yaml.org/) string into an object.

### `stringifyYaml(value, options?)`

Converts a JavaScript value to a [YAML](https://yaml.org/) string.


<!-- /automd -->

## Development

- Clone this repository
Expand Down

0 comments on commit 42c7ff6

Please sign in to comment.